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 root парола. Необходима за инициализация на базата данни и административни операции. |
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 графиците и показването на дати. Използвайте наименование от базата данни на часовите зони (например 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 realm (например rtsurvey). |
KEYCLOAK_CLIENT_ID | — | Keycloak client ID за приложението rtCloud. |
KEYCLOAK_CLIENT_SECRET | — | Keycloak client secret. Генерирайте от конзолата на 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 | — | Client ID, регистриран при вашия доставчик на самоличност. |
OIDC_CLIENT_SECRET | — | Client secret от вашия доставчик на самоличност. |
OIDC_SCOPE | openid profile email | Разделен с интервали списък от OIDC обхвати за заявка. |
OIDC_REDIRECT_URI | — | Callback URL за уеб приложението (например https://rtcloud.example.com/auth/callback). |
OIDC_MOBILE_CLIENT_ID | — | Отделен client ID за мобилното приложение rtSurvey. |
OIDC_MOBILE_REDIRECT_URI | — | Callback 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 ID на приложение (client). |
AZURE_TENANT_ID | Azure AD ID на директория (tenant). |
Незадължителни интеграции
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 съобщения
| Променлива | Описание |
|---|---|
MATRIX_HOMESERVER_HOST | Хост на Matrix homeserver. |
MATRIX_HOMESERVER_PORT | Порт на Matrix homeserver. |
Томове с данни
Всички данни на приложението се съхраняват в именувани 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
Беше ли полезна тази страница?