README

Оглавление

• Документация по сервису FreeFramework page-service-admin-authorization
  • Оглавление
  • Обзор пакета
    • Обязательные ключи конфигурации
    • Опциональные ключи и секции конфигурации
  • Требования
  • Сторонние компоненты
  • Общие данные по версиям сервисов

Обзор пакета

• page-service-admin-authorization — это базовый сервис для регистрации и авторизации администратора от FreeFramework. Это моностраничный сервис, но может подключаться как мультистраничный, закрывая область для доступа. Опционально поддерживает отправку нового пароля, rate limit и scfr токен.
• Сервис имеет много опциональных ключей в конфигурации.

Обязательные ключи конфигурации

• user_role — присвыимывая роль. Обязательно строка.
• redirect — путь для редиректа при успешной регистрации/авторизации. Не корректный ключь не позволяет корректно работать сервису, но регистрация/авторизация проходят.
• data_file_path — путь к файлу репозитория. Должен быть доступен на чтение для авторизации и для чтения и записи для регистрации.

Опциональные ключи и секции конфигурации

• templates — секция отвечающая за альтернативные пути к шаблонам стилю и скрипту. Использовать файлы "из коробки" нельзя в публичном режиме, так как директория vendor, должна быть закрыта для публичного доступа.
• validators — секция отвечающая за валидацию email и пароля, при ее отсутствии проверяеться только соответствие email шаблону.
• csfr — секция отвечающая за csfr токен, при ее отсутствии токен не используеться.
• rate_limit — секция отвечающая за частоту запросов, при ее отсутствии частота не отслеживаеться.
• email — секция отвечающая за отправку нового пароля на email, при ее отсутствии запрос нового пароля отключен.
• password_generation — секция отвечающая за генерацию нового пароля, при ее отсутствии пароль: 1234.
• register — ключ отвечающий за возможность регистрации. Должен быть true.

Требования

• PHP: версия 8.2 или выше
• Composer: для управления зависимостями
• "freeframework/core-service-kernel": "^1.0.0"
• "freeframework/core-service-https-router": "^1.0.0"
• "freeframework/core-service-session": "^1.0.0"
• "freeframework/core-service-page-controller": "^1.0.0"
• "phpmailer/phpmailer": "^7.0"

Сторонние компоненты

Данный пакет использует phpmailer/phpmailer, который распространяется под лицензией LGPL-2.1-or-later. Полный текст лицензии и уведомление об авторских правах находятся в файле Licenses/LGPL-2.1.txt и THIRD_PARTY_LICENSES.md.

Общие данные по версиям сервисов

• Версии a и b - не совместимы.
• Версии a.b и a.c - обратно совместимы.
• Версии a.b.c и a.b.d - прямо и обратно совместимы.