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 | — | Так | Кореневий пароль 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 | — | Назва 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 | — | Frontend 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 issuer (наприклад, 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
| Змінна | Опис |
|---|---|
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
| Змінна | Опис |
|---|---|
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
Чи була ця сторінка корисною?