On this page
settings
Dokumentacja konfiguracji
Kompletna dokumentacja wszystkich zmiennych środowiskowych używanych do konfigurowania samodzielnie hostowanego wdrożenia rtCloud.
Cała konfiguracja odbywa się przez zmienne środowiskowe w pliku .env w katalogu głównym wdrożenia. Docker Compose odczytuje ten plik automatycznie — nie jest potrzebna flaga --env-file.
Zmienne oznaczone jako wymagane muszą być ustawione przed uruchomieniem kontenerów. Wszystkie pozostałe mają wartości domyślne i są opcjonalne.
Projekt
Te zmienne definiują tożsamość i punkt dostępu Twojej instancji rtCloud.
| Zmienna | Domyślnie | Wymagana | Opis |
|---|---|---|---|
PROJECT_ID | — | Tak | Unikalny identyfikator tego wdrożenia. Bez spacji ani znaków specjalnych. Używany jako prefiks do nazewnictwa wewnętrznego. |
PROJECT_URL | — | Tak | Nazwa domeny lub adres IP, pod którym użytkownicy uzyskują dostęp do aplikacji (np. rtcloud.example.com lub 192.168.1.100). |
PROJECT_TYPE | rtsurvey | Nie | Wariant platformy do aktywacji. Opcje: rtwork, rtsurvey, rthome. |
PROJECT_PORT | 80 | Nie | Port, na którym aplikacja nasłuchuje wewnątrz kontenera. Nie zmieniaj, chyba że wiesz, co robisz. |
HTTP_PROTOCOL | https | Nie | Protokół używany do konstruowania wewnętrznych URL. Ustaw na http, jeśli nie używasz SSL. |
Baza danych
Dane uwierzytelniające połączenia MySQL. Baza danych jest zarządzana automatycznie przez kontener MySQL — musisz tylko ustawić silne hasła.
| Zmienna | Domyślnie | Wymagana | Opis |
|---|---|---|---|
MYSQL_DATABASE | smartsurvey | Nie | Nazwa bazy danych aplikacji. |
MYSQL_USER | smartsurvey | Nie | Użytkownik MySQL dla aplikacji. |
MYSQL_PASSWORD | — | Tak | Hasło dla MYSQL_USER. Użyj silnej, unikalnej wartości. |
MYSQL_ROOT_PASSWORD | — | Tak | Hasło root MySQL. Wymagane do inicjalizacji bazy danych i operacji administratora. |
MYSQL_HOST | mysql | Nie | Nazwa hosta MySQL. Użyj wartości domyślnej, chyba że łączysz się z zewnętrzną bazą danych. |
MYSQL_PORT | 3306 | Nie | Port MySQL. |
Konto administratora
Konto administratora jest tworzone automatycznie przy pierwszym uruchomieniu świeżej bazy danych.
| Zmienna | Domyślnie | Wymagana | Opis |
|---|---|---|---|
ADMIN_PASSWORD | admin | Tak | Hasło dla wbudowanego użytkownika admin. Ustaw je przed pierwszym uruchomieniem. Nie ma efektu, jeśli baza danych już istnieje. |
Po pierwszym logowaniu zmień hasło administratora ze strony Ustawienia konta w interfejsie webowym.
Porty
Kontroluj, do których portów hosta aplikacja się podłącza.
| Zmienna | Domyślnie | Opis |
|---|---|---|
APP_PORT | 8080 | Port hosta dla głównego interfejsu webowego. Zmień, jeśli port 8080 jest już używany na serwerze. |
SHINY_PORT | 3838 | Port hosta dla serwera analitycznego Shiny. |
Środowisko uruchomieniowe
| Zmienna | Domyślnie | Opis |
|---|---|---|
RUN_ENV | prod | Środowisko uruchomieniowe. Użyj prod dla wdrożeń produkcyjnych, dev dla lokalnego tworzenia. |
RUN_MODE | admin | Rola kontenera. admin uruchamia pełny stos (web + kolejka + cron). worker uruchamia tylko przetwarzanie w tle (dla skalowania poziomego). |
TZ | Asia/Ho_Chi_Minh | Strefa czasowa serwera. Wpływa na znaczniki czasu dzienników, harmonogramy cron i wyświetlanie dat. Użyj nazwy ze strefy czasowej TZ (np. UTC, America/New_York, Europe/London). |
LOG_LEVEL | info | Szczegółowość dziennika aplikacji. Opcje: debug, info, warning, error. |
COMPOSE_PROJECT_NAME | rtcloud | Prefiks stosowany do wszystkich nazw kontenerów i wolumenów Docker. Zmień go przy uruchamianiu wielu instancji rtCloud na tym samym hoście. |
RESTART_POLICY | unless-stopped | Zachowanie przy restarcie kontenera Docker. Opcje: no, always, on-failure, unless-stopped. |
RTCLOUD_IMAGE | rtawebteam/rta-smartsurvey:survey-dockerize | Obraz Docker do użycia. Zmień tag, aby przypiąć konkretną wersję. |
REQUIRE_LICENSE | false | Włącz weryfikację klucza licencyjnego przy uruchomieniu. Skontaktuj się z RTA w sprawie informacji o licencji. |
Bezpieczeństwo
| Zmienna | Domyślnie | Opis |
|---|---|---|
CSRF_VALIDATION_ENABLED | true | Włącz walidację tokenu CSRF. Pozostaw true w środowisku produkcyjnym. Ustaw na false tylko podczas lokalnego tworzenia, jeśli napotkasz błędy 400 CSRF token could not be verified. |
GII_ENABLED | false | Włącz narzędzie generatora kodu frameworka Yii. Nigdy nie włączaj w środowisku produkcyjnym. |
SSO — Wbudowany Keycloak
Włącz dołączony kontener Keycloak dla pełnofunkcjonalnego korporacyjnego SSO. Wymaga domeny z HTTPS.
| Zmienna | Domyślnie | Opis |
|---|---|---|
EMBED_KEYCLOAK | false | Ustaw na true, aby uruchomić wbudowany kontener Keycloak. Aktywuje profil Docker Compose embed-keycloak. |
KEYCLOAK_URL | — | Pełny URL serwera Keycloak (np. https://rtcloud.example.com/auth). |
KEYCLOAK_REALM | — | Nazwa realmu Keycloak (np. rtsurvey). |
KEYCLOAK_CLIENT_ID | — | ID klienta Keycloak dla aplikacji rtCloud. |
KEYCLOAK_CLIENT_SECRET | — | Sekret klienta Keycloak. Wygeneruj go z konsoli administratora Keycloak. |
KEYCLOAK_ADMIN_USER | admin | Nazwa użytkownika administratora Keycloak. |
KEYCLOAK_ADMIN_PASSWORD | — | Hasło administratora Keycloak. |
KEYCLOAK_DB | keycloak | Nazwa bazy danych dla Keycloak. Tworzona automatycznie przy pierwszym uruchomieniu. |
KEYCLOAK_DB_USER | keycloak | Użytkownik bazy danych dla Keycloak. |
KEYCLOAK_DB_PASSWORD | — | Hasło bazy danych dla użytkownika Keycloak. |
KC_HOSTNAME | — | URL frontendu Keycloak (np. https://rtcloud.example.com/auth). |
KC_HOSTNAME_STRICT | false | Wymuszaj ścisłe dopasowanie nazwy hosta. Ustaw na true w środowisku produkcyjnym z ustaloną domeną. |
Zobacz Uwierzytelnianie SSO dla kompletnego przewodnika konfiguracji.
SSO — Zewnętrzny dostawca OIDC
Połącz się z istniejącym dostawcą tożsamości kompatybilnym z OIDC (Supabase, Auth0, Authentik, Okta itp.).
| Zmienna | Domyślnie | Opis |
|---|---|---|
OIDC_ISSUER_URL | — | URL odkrycia wystawcy OIDC (np. https://accounts.google.com). |
OIDC_CLIENT_ID | — | ID klienta zarejestrowany u dostawcy tożsamości. |
OIDC_CLIENT_SECRET | — | Sekret klienta od dostawcy tożsamości. |
OIDC_SCOPE | openid profile email | Rozdzielona spacjami lista zakresów OIDC do żądania. |
OIDC_REDIRECT_URI | — | URL callback dla aplikacji webowej (np. https://rtcloud.example.com/auth/callback). |
OIDC_MOBILE_CLIENT_ID | — | Oddzielny ID klienta dla aplikacji mobilnej rtSurvey. |
OIDC_MOBILE_REDIRECT_URI | — | URI callback aplikacji mobilnej (np. vn.rta.rtsurvey.auth://callback). |
OPEN_REGISTRATION | false | Automatycznie twórz konta rtCloud dla użytkowników, którzy po raz pierwszy uwierzytelniają się przez OIDC. |
OIDC_AUTHORIZATION_ENDPOINT | — | Zastąp URL punktu końcowego autoryzacji (zostaw puste, aby używać odkrycia). |
OIDC_TOKEN_ENDPOINT | — | Zastąp URL punktu końcowego tokenu (zostaw puste, aby używać odkrycia). |
OIDC_USERINFO_ENDPOINT | — | Zastąp URL punktu końcowego informacji o użytkowniku (zostaw puste, aby używać odkrycia). |
SSO — Azure Active Directory
| Zmienna | Opis |
|---|---|
AZURE_CLIENT_ID | ID aplikacji (klienta) Azure AD. |
AZURE_TENANT_ID | ID katalogu (dzierżawcy) Azure AD. |
Opcjonalne integracje
Stata
| Zmienna | Domyślnie | Opis |
|---|---|---|
STATA_ENABLED | false | Włącz integrację z oprogramowaniem statystycznym Stata do analizy danych. |
STATA_BIN_PATH | /usr/bin/stata | Bezwzględna ścieżka do pliku binarnego Stata wewnątrz kontenera. |
Elasticsearch
| Zmienna | Opis |
|---|---|
ES_HOST | Host Elasticsearch (np. http://elasticsearch:9200). |
ES_PORT | Port Elasticsearch. |
Matomo Analytics
| Zmienna | Opis |
|---|---|
PIWIK_URL | URL serwera Matomo (Piwik). |
PIWIK_ID | ID witryny Matomo. |
PIWIK_SECRET | Token uwierzytelniający Matomo. |
OpenCPU (obliczenia R)
| Zmienna | Opis |
|---|---|
OCPU_HOST | URL serwera OpenCPU do statystycznych obliczeń opartych na R. |
Integracja RtBox
| Zmienna | Opis |
|---|---|
RTBOX_HOST | URL hosta usługi RtBox. |
RTBOX_USER_API | Klucz API użytkownika RtBox. |
RTBOX_BASIC_AUTH | Dane uwierzytelniające Basic Auth dla RtBox. |
Wiadomości Matrix
| Zmienna | Opis |
|---|---|
MATRIX_HOMESERVER_HOST | Host serwera domowego Matrix. |
MATRIX_HOMESERVER_PORT | Port serwera domowego Matrix. |
Wolumeny danych
Wszystkie dane aplikacji są przechowywane w nazwanych wolumenach Docker. Wolumeny są automatycznie tworzone przy pierwszym uruchomieniu i utrzymują się przez restarty i aktualizacje kontenerów.
| Wolumen | Punkt montowania | Zawartość |
|---|---|---|
rtcloud_mysql_data | /var/lib/mysql | Pliki bazy danych MySQL |
rtcloud_uploads | …/uploads | Pliki przesłane przez respondentów ankiety |
rtcloud_audios | …/audios | Nagrania audio |
rtcloud_downloads | …/downloads | Wygenerowane pliki eksportu |
rtcloud_gallery | …/gallery | Obrazy galerii |
rtcloud_voicemail | …/voicemail | Nagrania poczty głosowej |
rtcloud_analytics | …/analytics | Dane analityczne |
rtcloud_aggregate | …/aggregate | Zagregowane wyniki ankiety |
rtcloud_converter | …/converter | Wyniki konwersji danych |
rtcloud_shiny_data | /srv/shiny-server/smartsurvey | Skrypty R serwera Shiny |
rtcloud_shiny_logs | /var/log/shiny-server | Dzienniki serwera Shiny |
rtcloud_assets | …/assets | Zasoby webowe (CSS, JS) |
rtcloud_runtime | …/protected/runtime | Pamięć podręczna środowiska uruchomieniowego aplikacji |
rtcloud_cache | …/cache | Pamięć podręczna aplikacji |
rtcloud_tmp | …/tmp | Pliki tymczasowe |
Nazwy wolumenów są poprzedzone wartością COMPOSE_PROJECT_NAME (domyślnie: rtcloud).
Wyświetl wszystkie wolumeny dla swojego wdrożenia:
docker volume ls | grep rtcloud
Czy ta strona była pomocna?