On this page
settings
Справочник по конфигурации
Полный справочник по всем переменным окружения для настройки самостоятельно размещённого развёртывания rtCloud.
Вся конфигурация выполняется через переменные окружения в файле .env в корне каталога развёртывания. Docker Compose читает этот файл автоматически — флаг --env-file не требуется.
Переменные, помеченные как обязательные, должны быть установлены перед запуском контейнеров. Остальные имеют значения по умолчанию и являются необязательными.
Проект
Эти переменные определяют идентификатор и точку доступа вашего экземпляра rtCloud.
| Переменная | По умолчанию | Обязательная | Описание |
|---|---|---|---|
PROJECT_ID | — | Да | Уникальный идентификатор этого развёртывания. Без пробелов и специальных символов. Используется как префикс для внутренних названий. |
PROJECT_URL | — | Да | Доменное имя или IP-адрес, по которому пользователи обращаются к приложению (например, rtcloud.example.com или 192.168.1.100). |
PROJECT_TYPE | rtsurvey | Нет | Вариант платформы для активации. Варианты: rtwork, rtsurvey, rthome. |
PROJECT_PORT | 80 | Нет | Порт, на котором приложение слушает внутри контейнера. Не изменяйте, если не знаете, что делаете. |
HTTP_PROTOCOL | https | Нет | Протокол для построения внутренних URL. Установите http, если не используете SSL. |
База данных
Учётные данные для подключения к MySQL. База данных управляется автоматически контейнером MySQL — вам нужно только установить надёжные пароли.
| Переменная | По умолчанию | Обязательная | Описание |
|---|---|---|---|
MYSQL_DATABASE | smartsurvey | Нет | Имя базы данных приложения. |
MYSQL_USER | smartsurvey | Нет | Пользователь MySQL для приложения. |
MYSQL_PASSWORD | — | Да | Пароль для MYSQL_USER. Используйте надёжное уникальное значение. |
MYSQL_ROOT_PASSWORD | — | Да | Пароль root MySQL. Необходим для инициализации базы данных и административных операций. |
MYSQL_HOST | mysql | Нет | Имя хоста MySQL. Используйте значение по умолчанию, если не подключаетесь к внешней базе данных. |
MYSQL_PORT | 3306 | Нет | Порт MySQL. |
Учётная запись администратора
Учётная запись администратора создаётся автоматически при первом запуске с чистой базой данных.
| Переменная | По умолчанию | Обязательная | Описание |
|---|---|---|---|
ADMIN_PASSWORD | admin | Да | Пароль для встроенного пользователя admin. Установите до первого запуска. Не действует, если база данных уже существует. |
После первого входа смените пароль администратора на странице Настройки учётной записи в веб-интерфейсе.
Порты
Управляют тем, к каким портам хоста привязывается приложение.
| Переменная | По умолчанию | Описание |
|---|---|---|
APP_PORT | 8080 | Порт хоста для основного веб-интерфейса. Измените, если порт 8080 уже используется на вашем сервере. |
SHINY_PORT | 3838 | Порт хоста для аналитического сервера Shiny. |
Среда выполнения
| Переменная | По умолчанию | Описание |
|---|---|---|
RUN_ENV | prod | Среда выполнения. Используйте prod для производственных развёртываний, dev для локальной разработки. |
RUN_MODE | admin | Роль контейнера. admin запускает полный стек (веб + очередь + cron). worker запускает только фоновую обработку (для горизонтального масштабирования). |
TZ | Asia/Ho_Chi_Minh | Часовой пояс сервера. Влияет на временные метки журналов, расписания cron и отображение дат. Используйте имя часового пояса TZ (например, UTC, America/New_York, Europe/London). |
LOG_LEVEL | info | Детализация журналов приложения. Варианты: debug, info, warning, error. |
COMPOSE_PROJECT_NAME | rtcloud | Префикс для имён всех Docker-контейнеров и томов. Измените при запуске нескольких экземпляров rtCloud на одном хосте. |
RESTART_POLICY | unless-stopped | Политика перезапуска Docker-контейнеров. Варианты: no, always, on-failure, unless-stopped. |
RTCLOUD_IMAGE | rtawebteam/rta-smartsurvey:survey-dockerize | Используемый образ Docker. Измените тег для фиксации конкретной версии. |
REQUIRE_LICENSE | false | Включить проверку лицензионного ключа при запуске. Свяжитесь с RTA для получения информации о лицензии. |
Безопасность
| Переменная | По умолчанию | Описание |
|---|---|---|
CSRF_VALIDATION_ENABLED | true | Включить проверку CSRF-токена. Оставьте true в производственной среде. Установите false только в локальной разработке при ошибках 400 CSRF token could not be verified. |
GII_ENABLED | false | Включить инструмент генерации кода фреймворка Yii. Никогда не включайте в производственной среде. |
SSO — Встроенный Keycloak
Включите встроенный контейнер Keycloak для полнофункционального корпоративного SSO. Требует домена с HTTPS.
| Переменная | По умолчанию | Описание |
|---|---|---|
EMBED_KEYCLOAK | false | Установите true для запуска встроенного контейнера Keycloak. Активирует профиль Docker Compose embed-keycloak. |
KEYCLOAK_URL | — | Полный URL сервера Keycloak (например, https://rtcloud.example.com/auth). |
KEYCLOAK_REALM | — | Имя области Keycloak (например, rtsurvey). |
KEYCLOAK_CLIENT_ID | — | Идентификатор клиента Keycloak для приложения rtCloud. |
KEYCLOAK_CLIENT_SECRET | — | Секрет клиента Keycloak. Генерируется в консоли администратора Keycloak. |
KEYCLOAK_ADMIN_USER | admin | Имя пользователя администратора Keycloak. |
KEYCLOAK_ADMIN_PASSWORD | — | Пароль администратора Keycloak. |
KEYCLOAK_DB | keycloak | Имя базы данных для Keycloak. Создаётся автоматически при первом запуске. |
KEYCLOAK_DB_USER | keycloak | Пользователь базы данных для Keycloak. |
KEYCLOAK_DB_PASSWORD | — | Пароль базы данных для пользователя Keycloak. |
KC_HOSTNAME | — | Внешний URL Keycloak (например, https://rtcloud.example.com/auth). |
KC_HOSTNAME_STRICT | false | Принудительное соответствие имени хоста. Установите true в производственной среде с фиксированным доменом. |
Полное руководство по настройке см. в разделе SSO-аутентификация.
SSO — Внешний провайдер OIDC
Подключение к существующему OIDC-совместимому поставщику идентификации (Supabase, Auth0, Authentik, Okta и т.д.).
| Переменная | По умолчанию | Описание |
|---|---|---|
OIDC_ISSUER_URL | — | URL обнаружения издателя OIDC (например, https://accounts.google.com). |
OIDC_CLIENT_ID | — | Идентификатор клиента, зарегистрированный у поставщика идентификации. |
OIDC_CLIENT_SECRET | — | Секрет клиента от поставщика идентификации. |
OIDC_SCOPE | openid profile email | Разделённый пробелами список областей OIDC для запроса. |
OIDC_REDIRECT_URI | — | URL обратного вызова для веб-приложения (например, https://rtcloud.example.com/auth/callback). |
OIDC_MOBILE_CLIENT_ID | — | Отдельный идентификатор клиента для мобильного приложения rtSurvey. |
OIDC_MOBILE_REDIRECT_URI | — | URI обратного вызова мобильного приложения (например, vn.rta.rtsurvey.auth://callback). |
OPEN_REGISTRATION | false | Автоматически создавать учётные записи rtCloud для пользователей, впервые аутентифицированных через OIDC. |
OIDC_AUTHORIZATION_ENDPOINT | — | Переопределить URL конечной точки авторизации (оставьте пустым для использования обнаружения). |
OIDC_TOKEN_ENDPOINT | — | Переопределить URL конечной точки токена (оставьте пустым для использования обнаружения). |
OIDC_USERINFO_ENDPOINT | — | Переопределить URL конечной точки информации о пользователе (оставьте пустым для использования обнаружения). |
SSO — Azure Active Directory
| Переменная | Описание |
|---|---|
AZURE_CLIENT_ID | Идентификатор приложения (клиента) Azure AD. |
AZURE_TENANT_ID | Идентификатор каталога (арендатора) Azure AD. |
Дополнительные интеграции
Stata
| Переменная | По умолчанию | Описание |
|---|---|---|
STATA_ENABLED | false | Включить интеграцию со статистическим программным обеспечением Stata для анализа данных. |
STATA_BIN_PATH | /usr/bin/stata | Абсолютный путь к бинарному файлу Stata внутри контейнера. |
Elasticsearch
| Переменная | Описание |
|---|---|
ES_HOST | Хост Elasticsearch (например, http://elasticsearch:9200). |
ES_PORT | Порт Elasticsearch. |
Matomo Analytics
| Переменная | Описание |
|---|---|
PIWIK_URL | URL сервера Matomo (Piwik). |
PIWIK_ID | Идентификатор сайта Matomo. |
PIWIK_SECRET | Токен аутентификации Matomo. |
OpenCPU (вычисления R)
| Переменная | Описание |
|---|---|
OCPU_HOST | URL сервера OpenCPU для статистических вычислений на R. |
Интеграция RtBox
| Переменная | Описание |
|---|---|
RTBOX_HOST | URL хоста сервиса RtBox. |
RTBOX_USER_API | Ключ API пользователя RtBox. |
RTBOX_BASIC_AUTH | Учётные данные базовой аутентификации для RtBox. |
Matrix Messaging
| Переменная | Описание |
|---|---|
MATRIX_HOMESERVER_HOST | Хост домашнего сервера Matrix. |
MATRIX_HOMESERVER_PORT | Порт домашнего сервера Matrix. |
Тома данных
Все данные приложения хранятся в именованных томах Docker. Тома создаются автоматически при первом запуске и сохраняются при перезапуске и обновлении контейнеров.
| Том | Точка монтирования | Содержимое |
|---|---|---|
rtcloud_mysql_data | /var/lib/mysql | Файлы базы данных MySQL |
rtcloud_uploads | …/uploads | Файлы, загруженные участниками опроса |
rtcloud_audios | …/audios | Аудиозаписи |
rtcloud_downloads | …/downloads | Сгенерированные файлы экспорта |
rtcloud_gallery | …/gallery | Изображения галереи |
rtcloud_voicemail | …/voicemail | Голосовые сообщения |
rtcloud_analytics | …/analytics | Аналитические данные |
rtcloud_aggregate | …/aggregate | Агрегированные результаты опроса |
rtcloud_converter | …/converter | Результаты преобразования данных |
rtcloud_shiny_data | /srv/shiny-server/smartsurvey | R-скрипты сервера Shiny |
rtcloud_shiny_logs | /var/log/shiny-server | Журналы сервера Shiny |
rtcloud_assets | …/assets | Веб-ресурсы (CSS, JS) |
rtcloud_runtime | …/protected/runtime | Кэш среды выполнения приложения |
rtcloud_cache | …/cache | Кэш приложения |
rtcloud_tmp | …/tmp | Временные файлы |
Имена томов имеют префикс из значения COMPOSE_PROJECT_NAME (по умолчанию: rtcloud).
Список всех томов для вашего развёртывания:
docker volume ls | grep rtcloud
Была ли эта страница полезной?