On this page
settings
Konfigūracijos nuoroda
Išsami visų aplinkos kintamųjų, naudojamų savarankiškai valdomam rtCloud diegimui konfigūruoti, nuoroda.
Visa konfigūracija atliekama per aplinkos kintamuosius .env faile diegimo katalogo šaknyje. „Docker Compose" automatiškai skaito šį failą – jokios --env-file žymos nereikia.
Kintamieji, pažymėti kaip privalomi, turi būti nustatyti prieš paleidžiant konteinerius. Visi kiti turi numatytąsias reikšmes ir yra neprivalomi.
Projektas
Šie kintamieji apibrėžia jūsų rtCloud instancijos identitetą ir prieigos tašką.
| Kintamasis | Numatytasis | Privalomas | Aprašymas |
|---|---|---|---|
PROJECT_ID | — | Taip | Unikalus šio diegimo identifikatorius. Be tarpų ar specialių simbolių. Naudojamas kaip vidinio pavadinimo priešdėlis. |
PROJECT_URL | — | Taip | Domeno vardas arba IP adresas, kuriuo naudotojai pasiekia programą (pvz., rtcloud.example.com arba 192.168.1.100). |
PROJECT_TYPE | rtsurvey | Ne | Aktyvuojama platformos varianta. Parinktys: rtwork, rtsurvey, rthome. |
PROJECT_PORT | 80 | Ne | Prievadas, kuriame programa klauso konteinerio viduje. Nekeiskite, nebent žinote, ką darote. |
HTTP_PROTOCOL | https | Ne | Protokolas, naudojamas vidiniams URL konstruoti. Nustatykite į http, jei nenaudojate SSL. |
Duomenų bazė
MySQL prisijungimo duomenys. Duomenų bazę automatiškai valdo MySQL konteineris – jums tereikia nustatyti stiprius slaptažodžius.
| Kintamasis | Numatytasis | Privalomas | Aprašymas |
|---|---|---|---|
MYSQL_DATABASE | smartsurvey | Ne | Programos duomenų bazės pavadinimas. |
MYSQL_USER | smartsurvey | Ne | MySQL naudotojas programai. |
MYSQL_PASSWORD | — | Taip | Slaptažodis MYSQL_USER. Naudokite stiprią, unikalią reikšmę. |
MYSQL_ROOT_PASSWORD | — | Taip | MySQL šakninio naudotojo slaptažodis. Reikalingas duomenų bazės inicializavimui ir administravimo operacijoms. |
MYSQL_HOST | mysql | Ne | MySQL pagrindinio kompiuterio vardas. Naudokite numatytąjį, nebent jungiamasi prie išorinės duomenų bazės. |
MYSQL_PORT | 3306 | Ne | MySQL prievadas. |
Administratoriaus paskyra
Administratoriaus paskyra sukuriama automatiškai pirmojo paleidimo metu su nauja duomenų baze.
| Kintamasis | Numatytasis | Privalomas | Aprašymas |
|---|---|---|---|
ADMIN_PASSWORD | admin | Taip | Integruoto admin naudotojo slaptažodis. Nustatykite prieš pirmąjį paleidimą. Neturi poveikio, jei duomenų bazė jau egzistuoja. |
Pirmą kartą prisijungę, pakeiskite administratoriaus slaptažodį žiniatinklio sąsajos Paskyros nustatymų puslapyje.
Prievadai
Kontroliuokite, prie kurių pagrindinio kompiuterio prievadų programa prisiriša.
| Kintamasis | Numatytasis | Aprašymas |
|---|---|---|
APP_PORT | 8080 | Pagrindinio kompiuterio prievadas pagrindinei žiniatinklio sąsajai. Pakeiskite, jei prievadas 8080 jau naudojamas jūsų serveryje. |
SHINY_PORT | 3838 | Pagrindinio kompiuterio prievadas Shiny analizės serveriui. |
Vykdymo aplinka
| Kintamasis | Numatytasis | Aprašymas |
|---|---|---|
RUN_ENV | prod | Vykdymo aplinka. Naudokite prod gamybos diegimams, dev vietiniam kūrimui. |
RUN_MODE | admin | Konteinerio vaidmuo. admin paleidžia visą rinkinį (žiniatinklis + eilė + cron). worker paleidžia tik foninį apdorojimą (horizontaliam masteliui). |
TZ | Asia/Ho_Chi_Minh | Serverio laiko juosta. Veikia žurnalų laiko žymes, cron grafikus ir datos rodymą. Naudokite TZ duomenų bazės pavadinimą (pvz., UTC, America/New_York, Europe/London). |
LOG_LEVEL | info | Programos žurnalo išsamumas. Parinktys: debug, info, warning, error. |
COMPOSE_PROJECT_NAME | rtcloud | Priešdėlis, taikomas visiems „Docker" konteinerio ir tomo pavadinimams. Pakeiskite paleidžiant kelias rtCloud instancijas tame pačiame pagrindiniame kompiuteryje. |
RESTART_POLICY | unless-stopped | „Docker" konteinerio paleidimo iš naujo elgesys. Parinktys: no, always, on-failure, unless-stopped. |
RTCLOUD_IMAGE | rtawebteam/rta-smartsurvey:survey-dockerize | Naudojamas „Docker" vaizdas. Pakeiskite žymą konkrečiai versijai prisegti. |
REQUIRE_LICENSE | false | Įjunkite licencijos rakto tikrinimą paleidimo metu. Susisiekite su RTA dėl licencijos informacijos. |
Saugumas
| Kintamasis | Numatytasis | Aprašymas |
|---|---|---|
CSRF_VALIDATION_ENABLED | true | Įjunkite CSRF žetono tikrinimą. Gamyboje palikite true. Nustatykite į false tik vietiniame kūrime, jei susiduriate su 400 CSRF token could not be verified klaidomis. |
GII_ENABLED | false | Įjunkite „Yii" karkaso kodo generatoriaus įrankį. Niekada neįjunkite gamyboje. |
SSO – integruotas Keycloak
Įjunkite susietą Keycloak konteinerį visavertiam įmonės SSO. Reikalingas domenas su HTTPS.
| Kintamasis | Numatytasis | Aprašymas |
|---|---|---|
EMBED_KEYCLOAK | false | Nustatykite į true, kad paleistumėte integruotą Keycloak konteinerį. Aktyvuoja embed-keycloak „Docker Compose" profilį. |
KEYCLOAK_URL | — | Visas Keycloak serverio URL (pvz., https://rtcloud.example.com/auth). |
KEYCLOAK_REALM | — | Keycloak srities pavadinimas (pvz., rtsurvey). |
KEYCLOAK_CLIENT_ID | — | rtCloud programos Keycloak kliento ID. |
KEYCLOAK_CLIENT_SECRET | — | Keycloak kliento paslaptis. Sugeneruokite Keycloak administravimo konsolėje. |
KEYCLOAK_ADMIN_USER | admin | Keycloak administratoriaus naudotojo vardas. |
KEYCLOAK_ADMIN_PASSWORD | — | Keycloak administratoriaus slaptažodis. |
KEYCLOAK_DB | keycloak | Keycloak duomenų bazės pavadinimas. Sukuriamas automatiškai pirmojo paleidimo metu. |
KEYCLOAK_DB_USER | keycloak | Keycloak duomenų bazės naudotojas. |
KEYCLOAK_DB_PASSWORD | — | Keycloak naudotojo duomenų bazės slaptažodis. |
KC_HOSTNAME | — | Keycloak priekinio galo URL (pvz., https://rtcloud.example.com/auth). |
KC_HOSTNAME_STRICT | false | Griežtas pagrindinio kompiuterio vardo atitikimas. Gamyboje su fiksuotu domenu nustatykite į true. |
Išsamų sąrankos vadovą rasite SSO autentifikavimas.
SSO – išorinis OIDC teikėjas
Prijunkite prie esamo OIDC suderinamojo tapatybės teikėjo (Supabase, Auth0, Authentik, Okta ir kt.).
| Kintamasis | Numatytasis | Aprašymas |
|---|---|---|
OIDC_ISSUER_URL | — | OIDC išdavėjo atradimo URL (pvz., https://accounts.google.com). |
OIDC_CLIENT_ID | — | Jūsų tapatybės teikėje registruoto kliento ID. |
OIDC_CLIENT_SECRET | — | Jūsų tapatybės teikėjo kliento paslaptis. |
OIDC_SCOPE | openid profile email | Tarpais atskirtas OIDC sričių, kurias reikia prašyti, sąrašas. |
OIDC_REDIRECT_URI | — | Žiniatinklio programos atgalinio skambinimo URL (pvz., https://rtcloud.example.com/auth/callback). |
OIDC_MOBILE_CLIENT_ID | — | Atskiras rtSurvey mobilios programos kliento ID. |
OIDC_MOBILE_REDIRECT_URI | — | Mobilios programos atgalinio skambinimo URI (pvz., vn.rta.rtsurvey.auth://callback). |
OPEN_REGISTRATION | false | Automatiškai kurkite rtCloud paskyras naudotojams, pirmą kartą autentifikuojamiems per OIDC. |
OIDC_AUTHORIZATION_ENDPOINT | — | Perrašykite autorizacijos galinio taško URL (palikite tuščią, kad naudotumėte atradimą). |
OIDC_TOKEN_ENDPOINT | — | Perrašykite žetono galinio taško URL (palikite tuščią, kad naudotumėte atradimą). |
OIDC_USERINFO_ENDPOINT | — | Perrašykite naudotojo informacijos galinio taško URL (palikite tuščią, kad naudotumėte atradimą). |
SSO – „Azure Active Directory"
| Kintamasis | Aprašymas |
|---|---|
AZURE_CLIENT_ID | „Azure AD" programos (kliento) ID. |
AZURE_TENANT_ID | „Azure AD" katalogo (nuomotojo) ID. |
Papildomos integracijos
Stata
| Kintamasis | Numatytasis | Aprašymas |
|---|---|---|
STATA_ENABLED | false | Įjunkite Stata statistinės programinės įrangos integraciją duomenų analizei. |
STATA_BIN_PATH | /usr/bin/stata | Absoliutus kelias iki Stata dvejetainio failo konteinerio viduje. |
Elasticsearch
| Kintamasis | Aprašymas |
|---|---|
ES_HOST | Elasticsearch pagrindinis kompiuteris (pvz., http://elasticsearch:9200). |
ES_PORT | Elasticsearch prievadas. |
Matomo analizė
| Kintamasis | Aprašymas |
|---|---|
PIWIK_URL | Matomo (Piwik) serverio URL. |
PIWIK_ID | Matomo svetainės ID. |
PIWIK_SECRET | Matomo autentifikacijos žetonas. |
OpenCPU (R skaičiavimas)
| Kintamasis | Aprašymas |
|---|---|
OCPU_HOST | OpenCPU serverio URL R pagrįstam statistiniam skaičiavimui. |
RtBox integracija
| Kintamasis | Aprašymas |
|---|---|
RTBOX_HOST | RtBox paslaugos pagrindinio kompiuterio URL. |
RTBOX_USER_API | RtBox naudotojo API raktas. |
RTBOX_BASIC_AUTH | Pagrindiniai autentifikacijos duomenys RtBox. |
Matrix pranešimų sistema
| Kintamasis | Aprašymas |
|---|---|
MATRIX_HOMESERVER_HOST | Matrix namų serverio pagrindinis kompiuteris. |
MATRIX_HOMESERVER_PORT | Matrix namų serverio prievadas. |
Duomenų tomai
Visi programos duomenys saugomi pavadintuose „Docker" tomuose. Tomai sukuriami automatiškai pirmojo paleidimo metu ir išlieka per konteinerių paleidimus iš naujo ir atnaujinimus.
| Tomas | Montavimo taškas | Turinys |
|---|---|---|
rtcloud_mysql_data | /var/lib/mysql | MySQL duomenų bazės failai |
rtcloud_uploads | …/uploads | Apklausos respondentų įkelti failai |
rtcloud_audios | …/audios | Garso įrašai |
rtcloud_downloads | …/downloads | Sugeneruoti eksporto failai |
rtcloud_gallery | …/gallery | Galerijos vaizdai |
rtcloud_voicemail | …/voicemail | Balso pašto įrašai |
rtcloud_analytics | …/analytics | Analizės duomenys |
rtcloud_aggregate | …/aggregate | Apibendrinti apklausos rezultatai |
rtcloud_converter | …/converter | Duomenų konvertavimo išvestys |
rtcloud_shiny_data | /srv/shiny-server/smartsurvey | Shiny serverio R scenarijai |
rtcloud_shiny_logs | /var/log/shiny-server | Shiny serverio žurnalai |
rtcloud_assets | …/assets | Žiniatinklio ištekliai (CSS, JS) |
rtcloud_runtime | …/protected/runtime | Programos vykdymo talpykla |
rtcloud_cache | …/cache | Programos talpykla |
rtcloud_tmp | …/tmp | Laikinieji failai |
Tomų pavadinimai turi COMPOSE_PROJECT_NAME reikšmės priešdėlį (numatytasis: rtcloud).
Išvardykite visus savo diegimo tomus:
docker volume ls | grep rtcloud
Ar šis puslapis buvo naudingas?