BaronessAuth DocumentationBaronessAuth

📁 Структура плагина

Описание всех папок и файлов BaronessAuth

📁 Структура плагина BaronessAuth

После установки BaronessAuth в папке plugins/ создается директория BaronessAuth/ со следующей структурой:

📂 Основные папки

🔧 config/ - Конфигурационные файлы

Основная папка с настройками плагина.

Содержимое:

  • general.yml - основные настройки плагина
  • advanced.yml - продвинутые настройки
  • commands/ - настройки команд
  • methods/ - методы аутентификации
  • security/ - настройки безопасности

Описание:

Здесь хранятся все конфигурационные файлы плагина. При первом запуске создаются файлы по умолчанию. Изменения в этих файлах требуют перезапуска сервера.

📊 logs/ - Логи плагина

Папка с файлами логов различных событий.

Содержимое:

  • logins.txt - логи входов игроков
  • registrations.txt - логи регистраций
  • Другие лог-файлы по событиям

Описание:

Все действия игроков и системные события записываются в соответствующие лог-файлы. Полезно для мониторинга и отладки.

💾 backups/ - Резервные копии

Автоматически создаваемые резервные копии данных.

Содержимое:

  • Автоматические бэкапы базы данных
  • Резервные копии конфигурации
  • Архивы по датам

Описание:

Плагин автоматически создает резервные копии важных данных. Рекомендуется регулярно проверять эту папку и при необходимости очищать старые бэкапы.

🗄️ H2/ - База данных

Встроенная база данных H2 (если используется).

Содержимое:

  • data.mv.db - файл базы данных H2
  • Другие файлы БД

Описание:

Если вы используете встроенную базу данных H2, здесь хранятся все данные игроков, сессий и настроек. Не удаляйте эти файлы!

🔍 dump/ - Дампы данных

Папка для экспорта и импорта данных.

Содержимое:

  • Экспортированные данные игроков
  • Дампы конфигурации
  • Файлы для миграции

Описание:

Используется для экспорта данных в другие форматы, создания резервных копий и миграции между серверами.

🔒 Внутренние папки

⚙️ internal/ - Внутренние файлы

Системные файлы плагина.

Содержимое:

  • embedded-servers/ - файлы встроенных серверов
  • GeoLite2-Country.mmdb - база данных геолокации
  • loader/ - загрузчики библиотек

Описание:

Внутренние файлы плагина. Не изменяйте содержимое этой папки! Все файлы автоматически управляются плагином.

📍 internal/embedded-servers/

Файлы встроенных серверов аутентификации.

🌍 internal/GeoLite2-Country.mmdb

База данных для определения страны по IP-адресу. Используется для функций геолокации.

📚 internal/loader/

Загрузчики дополнительных библиотек и зависимостей.

📋 Подпапки конфигурации

🎮 config/commands/ - Настройки команд

Содержимое:

  • _shared.yml - общие настройки команд
  • baronessauth.yml - команды BaronessAuth
  • changepassword.yml - команда смены пароля
  • link.yml - команда привязки Telegram
  • logout.yml - команда выхода
  • unregister.yml - команда удаления аккаунта

🔐 config/methods/ - Методы аутентификации

Содержимое:

  • password.yml - настройки паролей
  • premium.yml - настройки премиум аутентификации
  • session.yml - настройки сессий
  • telegram.yml - настройки Telegram интеграции

🛡️ config/security/ - Настройки безопасности

Содержимое:

  • connection_filters.yml - фильтры подключений
  • passwords.yml - настройки безопасности паролей

📄 Важные файлы

📖 README.md

Документация плагина с основной информацией.

⚙️ config/general.yml

Главный конфигурационный файл с основными настройками.

🔧 config/advanced.yml

Файл с продвинутыми настройками для опытных пользователей.

⚠️ Важные замечания

🚫 Не изменяйте:

  • Папку internal/ - системные файлы
  • Файлы базы данных в H2/
  • Автоматически создаваемые файлы

✅ Можно изменять:

  • Все файлы в config/
  • Логи в logs/ (можно очищать)
  • Резервные копии в backups/

🔄 Изменения конфигурации:

  • Большинство изменений в config/ можно применить командой /auth reload
  • Некоторые настройки требуют полной перезагрузки сервера (указано в конфигурационных файлах)

🎯 Рекомендации

🔒 Безопасность:

  • Регулярно создавайте резервные копии
  • Не передавайте файлы базы данных третьим лицам
  • Храните бэкапы в безопасном месте