КриптоАРМ ГОСТ
КриптоАРМ
Как настроить переменные окружения КриптоАРМ ID#
В этом руководстве вы узнаете, как настроить переменные окружения КриптоАРМ ID на вашем сервере. Мы подробно разберем все параметры — от базы данных и OIDC до кэша, почты и интерфейса, чтобы ваша система работала корректно с первого запуска.
Содержание:
- Общие переменные окружения
- Переменные окружения базы данных (PostgreSQL)
- Redis, сессии и OIDC cookies
- Ограничение скорости и логирование
- Почта и уведомления
- Кастомизация интерфейса
- Права и лицензии
- Метрики
- Смотрите также
💡 Чтобы изменить переменные окружения, нужно внести изменения в файл docker-compose.yml.
Общие переменные окружения#
Эти переменные определяют базовое поведение и идентификацию сервиса.
| Переменная | Описание | Значение по умолчанию |
|---|---|---|
NODE_ENV | Среда выполнения приложения (development или production) | production |
DOMAIN | Домен сервиса | — |
ADMIN_LOGIN | Логин администратора | root |
ADMIN_PASSWORD | Пароль администратора | changethis |
DELETE_PROFILE_AFTER_DAYS | Количество дней, через которое профиль пользователя будет удален | 30 |
CLIENT_ID | Уникальный идентификатор приложения (рекомендуется UUID) | — |
CLIENT_SECRET | Уникальный секрет приложения (рекомендуется UUID) | — |
MANUAL_URL | Ссылка на документацию для пользователей | https://ваш-домен/docs/ |
⚠️ Переменные
CLIENT_IDиCLIENT_SECRETиспользуются для идентификации КриптоАРМ ID как OAuth 2.0 / OpenID Connect клиента и должны храниться в секрете.
Переменные окружения базы данных (PostgreSQL)#
Параметры для подключения к СУБД PostgreSQL.
| Переменная | Описание | Значение по умолчанию |
|---|---|---|
POSTGRES_USER | Имя пользователя для подключения к PostgreSQL | user |
POSTGRES_PASSWORD | Пароль пользователя PostgreSQL | password |
POSTGRES_DB | Название базы данных | mydb |
POSTGRES_HOST | Хост базы данных | localhost |
POSTGRES_PORT | Порт подключения к базе | 5432 |
DATABASE_URL | Полная строка подключения в формате PostgreSQL | — |
Redis, сессии и OIDC cookies#
Настройки для хранения сессий, кэширования данных и безопасности аутентификации.
| Переменная | Описание | Значение по умолчанию |
|---|---|---|
REDIS_HOST | Хост Redis | 127.0.0.1 |
REDIS_PORT | Порт Redis | 6379 |
OIDC_COOKIE_SECRET | Секрет для подписи и проверки cookie | — |
OIDC_SESSION_TTL | Время жизни сессии в секундах | 86400 (24 часа) |
Ограничение скорости и логирование#
Настройки для защиты от злоупотреблений и контроля логирования.
| Переменная | Описание | Значение по умолчанию |
|---|---|---|
RATE_LIMIT | Количество запросов для ограничения скорости | 15 |
RATE_LIMIT_TTL_SEC | Период времени в секундах для лимита | 900 |
CONSOLE_LOG_LEVELS | Уровни логирования для консоли | log warn error |
Почта и уведомления#
Настройки SMTP-сервера для отправки писем (подтверждение регистрации, сброс пароля и т.д.).
| Переменная | Описание | Значение по умолчанию | Пример |
|---|---|---|---|
EMAIL_PROVIDER | Настройки почтового провайдера в формате JSON | — | {"hostname":"smtp.example.com","port":465,"root_mail":"admin@example.com","password":"SecretPass"} |
Кастомизация интерфейса#
Внешний вид кнопок, ссылок и вкладок настраивается через JSON-объект в переменной CUSTOM_STYLES.
Переменная CUSTOM_STYLES позволяет кастомизировать интерфейс КриптоАРМ ID без изменения кода.
# Перейдите в папку проекта
cd /home/els/nodetrustedserverconfig
# Остановите сервис перед изменением
docker compose stop
# Отредактируйте .env файл
nano .env
# Пример минимальной кастомизации
CUSTOM_STYLES=`{"palette":{"white":{"accent":"#2c5aa0","accentHover":"#1e3a6f"}},"button":{"borderRadius":"8px"}}`
# Запустите сервис снова
docker compose up -d
Описание переменной CUSTOM_STYLES:
| Переменная | Описание | Пример |
|---|---|---|
CUSTOM_STYLES | Настройки внешнего вида интерфейса, включая цвета, стили кнопок и виджетов. Значение должно быть строго JSON в одну строку. | CUSTOM_STYLES={"palette":{"white":{"accent":"#ff6f00","accentHover":"#f56b00","onAccentColor":"#fff"}},"button":{"borderRadius":"4px"},"widget":{"backgroundColor":"#ff6f00","color":"#fff","isHideText":false,"button":{"background":"#ffffff","hover":"#fadfcd","color":"#ff6f00"}},"isAccordionIconColored":true,"contentPosition":"center"} |
| Параметр | Описание | Пример |
|---|---|---|
accent | Основной цвет акцентных элементов в HEX-формате | "#ff6f00" |
accentHover | Цвет при наведении в HEX-формате | "#f56b00" |
onAccentColor | Цвет текста на акцентном фоне в HEX-формате | "#fff" |
secondaryAccent | Цвет второстепенных элементов в HEX-формате | "#fae9de" |
borderColor | Цвет границ элементов в HEX-формате | "#858BA0" |
borderRadius | Закругление углов кнопок (button) | 4px, 8px и т.д. |
isAccordionIconColored | Раскрашивать иконки аккордеона | true/false |
contentPosition | Выравнивание контента | "start", "center", "end" |
Права и лицензии#
| Переменная | Описание | Значение по умолчанию | Пример |
|---|---|---|---|
COPYRIGHT | Информация о правах в формате JSON | {"ru":" ","en":" "} | {"ru":"© Компания","en":"© Company"} |
Метрики#
| Переменная | Описание |
|---|---|
YANDEX_METRICA_ID | ID для интеграции с Яндекс.Метрикой |
GOOGLE_METRICA_ID | ID для интеграции с Google Analytics |
Смотрите также#
- Установка системы КриптоАРМ ID — руководство по установке системы.
- Настройка системы — руководство по настройке интерфейса и доступа пользователей в систему.