Настройка HTML-шаблонов Avanpost FAM

Avanpost позволяет настроить внешний вид страниц, доступных неавторизованным пользователям:

  • страницы аутентификации с помощью различных методов и факторов;

  • страницы регистрации;

  • страницы восстановления доступа;

  • страницы аутентификации через доверенных провайдеров;

  • страницы инициализации аутентификаторов;

  • страницы ошибок;

  • шаблоны писем.

По умолчанию шаблоны страниц размещаются в директории /opt/idp/public/templates/default/.

Предупреждение
Не изменяйте HTML-файлы, размещённые в директории public/templates/! При очередном обновлении Avanpost их содержимое может быть сброшено к значениям по умолчанию.

Настройка шаблонов#

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

  • Сначала настройте шаблоны в тестовом окружении. Переносите их в продуктовое окружение только после того как полностью убедитесь в их работоспособности.

  • Храните файлы шаблонов в системе контроля версий, например Git .

Чтобы настроить шаблоны, выполните следующие действия:

  1. Скопируйте файлы из директории public/templates/default/ в новую директорию, например:

    cp -r \
       /opt/idp/public/templates/default/ \
       /opt/idp/public/templates/custom/
    
  2. Внесите в скопированные шаблоны необходимые изменения.

  3. В конфигурационном файле Avanpost config.json в значении параметра templates.templates укажите путь к директории с изменёнными шаблонами относительно корневого каталога Avanpost, например:

    {
      "templates": {
        "templates": "public/templates/custom"
      }
    }
    
  4. Перезапустите службы Avanpost.

Перечень шаблонов#

Таблица шаблонов, доступных для настройки:

Шаблон Описание
403.esia.html Страница Ошибка доступа при аутентификации через ЕСИА
403.html Страница Ошибка доступа для стандартных сценариев аутентификации
500.esia.html Страница Внутренняя ошибка сервера при аутентификации через ЕСИА
500.html Страница Внутренняя ошибка сервера для стандартных сценариев аутентификации
badrequest.html Страница Некорректный запрос для стандартных сценариев аутентификации
certfactor.html Страница аутентификации по сертификату
changepassword.badrequest.html Страница с ошибкой Некорректный запрос при выполнении смены пароля
changepassword.html Страница смены пароля
changepassword.invalidtoken.html Страница с ошибкой Некорректный токен при выполнении смены пароля
changepasswordlink.html Страница со ссылкой на смену пароля
changepassword.ok.html Страница с сообщением об успешной смене пароля
changepassword.usernotfound.html Страница с ошибкой о том, что не удалось найти пользователя при смене пароля
factorblockederror.html Страница с ошибкой Фактор заблокирован
kerberos.skip.html Страница пропуска Kerberos-аутентификации
login.emailOtp.codeForm.html Страница аутентификации по одноразовому коду, шаг запроса кода
login.emailOtp.initialForm.html Страница аутентификации по одноразовому коду, шаг инициализации запроса
login.external-provider.infoconfirmation.html Страница подтверждения данных пользователя при аутентификации через внешний провайдер аутентификации
login.password.from.esia.html Страница привязки учётной записи ЕСИА к пользователю, аутентифицированному через ЕСИА, посредством дополнительной аутентификации
login.password.html Страница аутентификации по паролю
login.password.without-username.html Страница аутентификации по паролю без ввода имени пользователя
login.paycontrol.prompt.html Страница запроса аутентификации по PayControl
login.totp.init.html Страница инициализации TOTP
login.totp.init.with-password.html Страница инициализации TOTP с вводом пароля
login.totp.passcode.html Страница запроса одноразового кода TOTP
login.totp.welcome.html Страница привязки TOTP-аутентификатора
logout.html Страница завершения сессии
mobile.init.html Страница привязки мобильного аутентификатора Avanpost Authenticator
mobile.password.html Страница аутентификации посредством мобильного аутентификатора Avanpost Authenticator с возможностью ввода OTP
new.password.html Страница замены пароля в случае его истечения
notavailable.html Страница с ошибкой Нет доступа
oauth2-required-claims.html Страница с ожиданием появления значения дополнительного claim
pickfactor.html Страница выбора фактора аутентификации
pickfactor.username.html Страница выбора фактора аутентификации с идентификацией по имени пользователя
restorepassword.change.html Страница замены пароля в сценарии восстановления доступа
restorepassword.email.html Страница ввода E-mail в сценарии восстановления доступа
restorepassword.error.html Страница ошибки в сценарии восстановления доступа
restorepassword.sendlink.html Страница отправки письма на почту с идентификацией по логину
restorepassword.sendlink.withoutlogin.html Страница отправки письма на почту без запроса логина
restorepassword.verifycode.html Шаблон письма с кодом верификации
reverseproxy.accountregistration.html Страница добавления учётной записи Reverse Proxy-приложения в аккаунт пользователя, у которого не привязан ни один аккаунт RP-приложения
reverseproxy.changepassword.html Страница замены пароля Reverse Proxy-приложения в случае если пароль истёк или не подходит
selfregistration-emailmessage.html Шаблон письма об успешной регистрации
selfregistration.html Страница с формой самостоятельной регистрации
selfregistration-invalidtoken.html Страница с ошибкой о некорректном токене в сценарии самостоятельной регистрации
selfregistration-successed.html Страница с сообщением об успешной самостоятельной регистрации
selfregistration-verifycannotunlock.html Страница с сообщением о не пройденной проверке капчи
selfregistration-verifysuccessed.html Страница с сообщением о пройденной проверке капчи
session-limitexceeded.html Страница с сообщением о превышении числа доступных сессий для приложения
sms.html Страница аутентификации посредством SMS OTP
sms.init.html Страница привязки SMS OTP-аутентификатора
sms.phone.html Страница ввода номера телефона для привязки SMS OTP-аутентификатора
step.activate-by-email.html Страница с активацией аккаунта пользователя, прошедшего самостоятельную регистрацию, по E-mail
step.sms.html Страница с привязкой SMS-аутентификатора в процессе сценария инициализации
step.telegram.html Страница с привязкой Telegram-аутентификатора в процессе сценария инициализации
step.totp.html Страница с привязкой TOTP-аутентификатора в процессе сценария инициализации
telegram.html Страница с аутентификацией посредством Telegram
telegram.init.html Страница с инициализацией Telegram-аутентификатора в процессе аутентификации
webauthn.html Страница с аутентификацией посредством WebAuthn-аутентификатора в процессе аутентификации
webauthn.registration.html Страница с привязкой WebAuthn-аутентификатора в процессе аутентификации