Переменные окружения

Файл .env лежит рядом с docker-compose.yml. Создаётся копированием шаблона: cp .env.sample .env.

Версии

Переменная	Описание	Значение в шаблоне
`APP_VERSION`	Версия образа Yonote	`1.45.33`
`AUTH_VERSION`	Версия образа Keycloak	`19-0.1.0`

Для каждого сервиса нужен свой поддомен. Если Yonote доступен по адресу domain.ru, создайте записи auth.domain.ru и s3.domain.ru, указывающие на тот же сервер. Запись s3-admin.domain.ru для веб-консоли хранилища по желанию.

Переменная	Описание	Пример
`BASENAME_FOR_SUBDOMAIN`	Домен приложения	`domain.ru`
`YNT_HTTP_PROTOCOL`	Протокол приложения	`http://`
`YNT_WEBSOCKET_PROTOCOL`	Протокол WebSocket	`ws://`
`KC_YNT_HOST`	Домен Keycloak	`auth.domain.ru`
`KC_YNT_HOST_PROTOCOL`	Протокол Keycloak	`http://`
`KC_YNT_URL`	Полный адрес Keycloak	`${KC_YNT_HOST_PROTOCOL}${KC_YNT_HOST}`
`S3_YNT_HOST`	Домен хранилища файлов	`s3.domain.ru`
`S3_YNT_HOST_PROTOCOL`	Протокол хранилища	`http://`
`S3_YNT_URL`	Полный адрес хранилища	`${S3_YNT_HOST_PROTOCOL}${S3_YNT_HOST}`
`S3_ADMIN_YNT_HOST`	Домен веб-консоли хранилища (по желанию)	`s3-admin.domain.ru`

База данных

Переменная	Описание
`YNT_DB_NAME`	Имя базы приложения (`yonote`), создаётся автоматически
`YNT_DB_USER`	Пользователь PostgreSQL (`postgres`)
`YNT_DB_PASSWORD`	Пароль PostgreSQL. Задайте свой
`KC_DB`	Имя базы Keycloak (`keycloak`), создаётся автоматически
`KC_DB_USERNAME`	Пользователь базы Keycloak (`keycloak`)
`KC_DB_PASSWORD`	Пароль базы Keycloak. Задайте свой

Авторизация (Keycloak)

Переменная	Описание
`KC_USERNAME`	Логин администратора Keycloak
`KC_PASSWORD`	Пароль администратора Keycloak. Смените значение из шаблона

Хранилище файлов (SeaweedFS)

Переменная	Описание
`S3_ADMIN_USERNAME`	Логин администратора хранилища: вход в веб-консоль и административный ключ
`S3_ADMIN_PASSWORD`	Пароль администратора хранилища. Смените значение из шаблона
`S3_ACCESS_KEY_ID`	Ключ доступа приложения к хранилищу (`yonote`), пользователь создаётся автоматически
`S3_SECRET_ACCESS_KEY`	Секретный ключ приложения. Задайте свой
`AWS_S3_UPLOAD_MAX_SIZE`	Максимальный размер загружаемого файла в байтах (в шаблоне `226214400`, около 215 МБ)
`S3_PROXY_ENABLED`	Проксировать загрузку и выгрузку файлов через приложение (по умолчанию `false`)
`S3_MULTIPART_PART_SIZE`	Размер части при загрузке больших файлов, в мегабайтах (по умолчанию `1000`)

Секреты приложения

Переменная	Описание
`SECRET_KEY`	Ключ шифрования, 32 байта. Генерируется командой `openssl rand -hex 32`
`UTILS_SECRET`	Уникальный случайный ключ. Генерируется отдельно, той же командой. Им же подписываются запросы планировщика
`SERVICE_WORKER_PUBLIC_KEY` / `SERVICE_WORKER_PRIVATE_KEY`	Ключи Web Push, см. Установка
`LICENSE_KEY`	Лицензионный ключ: содержимое файла лицензии одной строкой, без кавычек
`LICENSE_EXP_REMINDER`	За сколько дней до окончания лицензии напоминать (необязательно)

Храните SECRET_KEY в надёжном месте и не меняйте его после первого запуска: сохранённые данные станет невозможно расшифровать.

Почта

Почта нужна для уведомлений и приглашений.

Переменная	Описание	Пример
`SMTP_HOST`	SMTP-сервер	`smtp.yandex.ru`
`SMTP_PORT`	Порт	`465`
`SMTP_USERNAME`	Логин
`SMTP_PASSWORD`	Пароль
`SMTP_FROM_EMAIL`	Адрес отправителя
`SMTP_REPLY_EMAIL`	Адрес для ответов (необязательно)
`SMTP_TLS_CIPHERS`	Шифры TLS (необязательно)
`SMTP_SECURE`	Использовать TLS	`true`

Если почта не нужна, закомментируйте строки SMTP_* в .env (поставьте #). Пустое значение SMTP_HOST= приложение считает ошибкой и не запускается.

Дополнительно

Эти переменные необязательны.

Переменная	Описание
`FORCE_HTTPS`	Перенаправлять запросы с HTTP на HTTPS. Для установки без HTTPS значение `false`
`WEB_CONCURRENCY`	Количество процессов приложения. Простой расчёт: объём памяти сервера в МБ, делённый на 512
`MAXIMUM_IMPORT_SIZE`	Максимальный размер файла импорта (из Notion, Confluence и других) в байтах
`ALLOWED_DOMAINS`	Почтовые домены, с которых разрешена регистрация, через запятую. По умолчанию любые
`TEAM_LOGO`	Адрес логотипа, который показывается при входе (уменьшается до высоты 60px)
`DEFAULT_LANGUAGE`	Язык по умолчанию (в шаблоне `ru_RU`)
`TELEGRAM_BOT_TOKEN`, `TELEGRAM_BOT_URL`	Интеграция с Telegram. Без токена интеграция отключена