BaronessAuth DocumentationBaronessAuth

telegram.yml - Настройки Telegram аутентификации

Настройки Telegram аутентификации в BaronessAuth

Файл telegram.yml

Путь: content/BaronessAuth/config/methods/telegram.yml

Настройки двухфакторной аутентификации через Telegram бота. Этот метод позволяет игрокам получать уведомления о входах и подтверждать их через Telegram.

📋 Содержимое файла

# ┌────────────────────────────────
# │ Настройки Telegram аутентификации
# └────────────────────────────────
enabled: false

# Человеческое название этого способа, чтобы в редких случаях показать игрокам.
display-name: '2FA в Telegram'

# ┌────────────────────────────────
# │ Настройки бота - данные для подключения, сообщения, клавиатура и так далее
# └────────────────────────────────
bot:
  # Токен для доступа к боту, его вам даст https://t.me/BotFather
  token: 'токен-бота-телеграм'

  # Команды для ввода кода. Если указать пустую команду, любое сообщение будет считаться попыткой ввести код.
  commands:
  - ''
  - '/привязать'
  - '!привязать'
  - '/привязка'
  - '!привязка'
  - '/link'

  # Принимать корректные коды, даже если команда была указана неправильно? На случай тупняка игроков.
  handle-valid-code-even-when-command-is-invalid: true

  # Здесь можно включить требование подписаться на каналы или чаты, прежде чем пользоваться ботом.
  # [ВАЖНО] Вы должны добавить бота в эти каналы и группы в качестве админа (права никакие не нужны).
  require-channel-subscription:
    enabled: false
    ids:
    - -1001603471277
    message: '⛔ Для использования бота вы должны подписаться на <вставьте своё>.'

  # ┌────────────────────────────────
  # │ Тут находятся все сообщения бота.
  # └────────────────────────────────
  messages:

    # Когда пользователь вызвал невозможное действие (например, пытается привязать аккаунт, который уже удалён).
    invalid-action: '❓ Это действие больше неактуально.'

    # Когда пользователь исчерпал лимит привязки игроков к аккаунту.
    too-many-links-for-account: '⭕ Вы не можете привязать ещё больше игроков к этому
      аккаунту.'

    # Когда пользователь успешно привязал аккаунт.
    successful-link: '✅ Вы успешно привязали аккаунт <name>!'

    # Когда пользователю нужно выбрать аккаунт (если у него их несколько).
    select-account: 'Выберите аккаунт:'

    # Когда пользователю нужно принять или отклонить запрос 2FA.
    2fa-request-start: |-
      ⚠ На ваш аккаунт, <name>, пытаются войти с IP <address> (<city>, <country>).

      **Тот, кто пытается войти, правильно ввёл ваш пароль!**
      Если это не вы, отклоните и **смените пароль немедленно** (нажмите "сброс пароля")!

    # Когда пользователь принял запрос 2FA.
    2fa-request-accept: '✅ Вы приняли вход на аккаунт <name> с IP <address> (<city>,
      <country>).'

    # Когда пользователь отклонил запрос 2FA.
    2fa-request-decline: |-
      ⭕ Вы отклонили вход на аккаунт <name> с IP <address> (<city>, <country>).

      Если это были не вы, смените пароль немедленно (нажмите "сброс пароля")!

    # Когда пользователь отклонил запрос 2FA.
    2fa-request-cancel: |-
      ⭕ На ваш аккаунт, <name>, пытались войти с IP <address> (<city>, <country>).

      Процесс был отменён - игрок не вошёл.

      Если это были не вы, смените пароль немедленно (нажмите "сброс пароля")!

    # Уведомление при успешном логине.
    notification-login: |-
      🔔 На ваш аккаунт, <name>, вошли, используя <methods>.
      Вход был с IP <address> (<city>, <country>).

    # Когда пользователь не указал код в сообщении.
    invalid-input: |-
      ❓ Вы хотели привязать аккаунт?
      Зайдите на сервер, введите `/link telegram` и полученный код отправьте сюда.

    # Когда пользователь указан неактивный код.
    unknown-code: |-
      ❓ Неизвестный код.
      Зайдите на сервер и введите `/link telegram`, чтобы получить новый.

  # ┌────────────────────────────────
  # │ находятся все кнопки бота.
  # └────────────────────────────────
  buttons:

    # Здесь можно расположить кнопки:
    #   STATUS

🔧 Основные секции

Bot

Настройки Telegram бота:

  • token - токен бота от @BotFather
  • commands - команды для ввода кода
  • handle-valid-code-even-when-command-is-invalid - принимать коды даже при неправильной команде

Require Channel Subscription

Требование подписки на каналы:

  • enabled - включить/выключить требование подписки
  • ids - ID каналов для подписки
  • message - сообщение при отсутствии подписки

Messages

Сообщения бота:

  • invalid-action - неактуальное действие
  • too-many-links-for-account - превышен лимит привязок
  • successful-link - успешная привязка
  • select-account - выбор аккаунта
  • 2fa-request-* - сообщения для 2FA
  • notification-login - уведомление о входе
  • invalid-input - неправильный ввод
  • unknown-code - неизвестный код

Buttons

Кнопки бота для взаимодействия

🔐 Как это работает

  1. Создание бота - создайте бота через @BotFather
  2. Настройка токена - вставьте токен в конфиг
  3. Привязка аккаунта - игрок вводит /link telegram на сервере
  4. Получение кода - игрок получает код для привязки
  5. Отправка кода - игрок отправляет код боту
  6. Подтверждение - аккаунт привязан к Telegram

🔐 Рекомендуемые настройки

Для большинства серверов безопасные настройки:

enabled: true
display-name: '2FA в Telegram'

bot:
  token: 'ВАШ_ТОКЕН_БОТА'
  
  commands:
  - ''
  - '/link'
  
  handle-valid-code-even-when-command-is-invalid: true
  
  require-channel-subscription:
    enabled: false

⚠️ Важно

  • Получите токен бота у @BotFather
  • Добавьте бота в каналы как админа (если используете require-channel-subscription)
  • Игроки должны привязать аккаунт командой /link telegram
  • 2FA работает только для привязанных аккаунтов
  • Уведомления приходят на все привязанные аккаунты