すべての設定はデプロイディレクトリのルートにある.envファイル内の環境変数で行います。Docker Composeはこのファイルを自動的に読み込みます — --env-fileフラグは不要です。

必須と記載された変数はコンテナを起動する前に設定する必要があります。その他はデフォルト値があり、オプションです。


プロジェクト

これらの変数はrtCloudインスタンスのIDとアクセスポイントを定義します。

変数デフォルト必須説明
PROJECT_IDはいこのデプロイの一意の識別子。スペースや特殊文字は不可。内部命名のプレフィックスとして使用される。
PROJECT_URLはいユーザーがアプリにアクセスするドメイン名またはIPアドレス(例:rtcloud.example.comまたは192.168.1.100)。
PROJECT_TYPErtsurveyいいえ有効にするプラットフォームのバリアント。オプション:rtworkrtsurveyrthome
PROJECT_PORT80いいえコンテナ内でアプリケーションがリッスンするポート。理解している場合を除き変更しないこと。
HTTP_PROTOCOLhttpsいいえ内部URLの構築に使用するプロトコル。SSLを使用しない場合はhttpに設定する。

データベース

MySQL接続の認証情報。データベースはMySQLコンテナによって自動的に管理されます — 強力なパスワードを設定するだけです。

変数デフォルト必須説明
MYSQL_DATABASEsmartsurveyいいえアプリケーションデータベースの名前。
MYSQL_USERsmartsurveyいいえアプリケーション用のMySQLユーザー。
MYSQL_PASSWORDはいMYSQL_USERのパスワード。強力で一意の値を使用する。
MYSQL_ROOT_PASSWORDはいMySQLのrootパスワード。データベースの初期化と管理操作に必要。
MYSQL_HOSTmysqlいいえMySQLのホスト名。外部データベースに接続する場合を除き、デフォルトを使用する。
MYSQL_PORT3306いいえMySQLのポート。

管理者アカウント

管理者アカウントは新しいデータベースの初回起動時に自動的に作成されます。

変数デフォルト必須説明
ADMIN_PASSWORDadminはい組み込みのadminユーザーのパスワード。初回起動前に設定する。データベースがすでに存在する場合は効果がない。

初回ログイン後、Web UIのアカウント設定ページから管理者パスワードを変更してください。


ポート

アプリケーションがバインドするホストポートを制御します。

変数デフォルト説明
APP_PORT8080メインWeb UI用のホストポート。ポート8080がサーバーで既に使用されている場合は変更する。
SHINY_PORT3838Shiny分析サーバー用のホストポート。

ランタイム

変数デフォルト説明
RUN_ENVprodランタイム環境。本番デプロイにはprod、ローカル開発にはdevを使用する。
RUN_MODEadminコンテナのロール。adminはフルスタック(Web + キュー + cron)を実行する。workerはバックグラウンド処理のみを実行する(水平スケーリング用)。
TZAsia/Ho_Chi_Minhサーバーのタイムゾーン。ログのタイムスタンプ、cronスケジュール、日付表示に影響する。TZデータベース名を使用する(例:UTCAmerica/New_YorkEurope/London)。
LOG_LEVELinfoアプリケーションログの詳細度。オプション:debuginfowarningerror
COMPOSE_PROJECT_NAMErtcloudすべてのDockerコンテナとボリューム名に付けられるプレフィックス。同じホストで複数のrtCloudインスタンスを実行する場合に変更する。
RESTART_POLICYunless-stoppedDockerコンテナの再起動動作。オプション:noalwayson-failureunless-stopped
RTCLOUD_IMAGErtawebteam/rta-smartsurvey:survey-dockerize使用するDockerイメージ。特定のバージョンに固定するにはタグを変更する。
REQUIRE_LICENSEfalse起動時のライセンスキー検証を有効にする。ライセンス情報についてはRTAに連絡する。

セキュリティ

変数デフォルト説明
CSRF_VALIDATION_ENABLEDtrueCSRFトークン検証を有効にする。本番環境ではtrueのままにする。400 CSRF token could not be verifiedエラーが発生する場合のみ、ローカル開発ではfalseに設定する。
GII_ENABLEDfalseYiiフレームワークのコードジェネレーターツールを有効にする。本番環境では絶対に有効にしないこと。

SSO — 組み込みKeycloak

エンタープライズSSOのフル機能のための組み込みKeycloakコンテナを有効にする。HTTPSを持つドメインが必要。

変数デフォルト説明
EMBED_KEYCLOAKfalse組み込みKeycloakコンテナを起動するにはtrueに設定する。embed-keycloak Docker Composeプロファイルを有効にする。
KEYCLOAK_URLKeycloakサーバーのフルURL(例:https://rtcloud.example.com/auth)。
KEYCLOAK_REALMKeycloakレルム名(例:rtsurvey)。
KEYCLOAK_CLIENT_IDrtCloudアプリケーション用のKeycloakクライアントID。
KEYCLOAK_CLIENT_SECRETKeycloakクライアントシークレット。Keycloak管理コンソールから生成する。
KEYCLOAK_ADMIN_USERadminKeycloak管理者ユーザー名。
KEYCLOAK_ADMIN_PASSWORDKeycloak管理者パスワード。
KEYCLOAK_DBkeycloakKeycloak用のデータベース名。初回起動時に自動作成される。
KEYCLOAK_DB_USERkeycloakKeycloak用のデータベースユーザー。
KEYCLOAK_DB_PASSWORDKeycloakユーザー用のデータベースパスワード。
KC_HOSTNAMEKeycloakフロントエンドURL(例:https://rtcloud.example.com/auth)。
KC_HOSTNAME_STRICTfalse厳密なホスト名マッチングを適用する。固定ドメインを持つ本番環境ではtrueに設定する。

完全なセットアップガイドについてはSSO認証を参照してください。


SSO — 外部OIDCプロバイダー

既存のOIDC互換IDプロバイダー(Supabase、Auth0、Authentik、Oktaなど)にrtCloudを接続する。

変数デフォルト説明
OIDC_ISSUER_URLOIDCイシュアー検出URL(例:https://accounts.google.com)。
OIDC_CLIENT_IDIDプロバイダーに登録されたクライアントID。
OIDC_CLIENT_SECRETIDプロバイダーのクライアントシークレット。
OIDC_SCOPEopenid profile email要求するOIDCスコープのスペース区切りリスト。
OIDC_REDIRECT_URIWebアプリのコールバック URL(例:https://rtcloud.example.com/auth/callback)。
OIDC_MOBILE_CLIENT_IDrtSurveyモバイルアプリ用の個別クライアントID。
OIDC_MOBILE_REDIRECT_URIモバイルアプリのコールバックURI(例:vn.rta.rtsurvey.auth://callback)。
OPEN_REGISTRATIONfalseOIDCを通じて初めて認証したユーザーのrtCloudアカウントを自動作成する。
OIDC_AUTHORIZATION_ENDPOINT認証エンドポイントURLを上書きする(検出を使用する場合は空白)。
OIDC_TOKEN_ENDPOINTトークンエンドポイントURLを上書きする(検出を使用する場合は空白)。
OIDC_USERINFO_ENDPOINTユーザー情報エンドポイントURLを上書きする(検出を使用する場合は空白)。

SSO — Azure Active Directory

変数説明
AZURE_CLIENT_IDAzure ADアプリケーション(クライアント)ID。
AZURE_TENANT_IDAzure ADディレクトリ(テナント)ID。

オプション統合

Stata

変数デフォルト説明
STATA_ENABLEDfalseデータ分析のためのStata統計ソフトウェア統合を有効にする。
STATA_BIN_PATH/usr/bin/stataコンテナ内のStataバイナリへの絶対パス。

Elasticsearch

変数説明
ES_HOSTElasticsearchのホスト(例:http://elasticsearch:9200)。
ES_PORTElasticsearchのポート。

Matomo分析

変数説明
PIWIK_URLMatomo(Piwik)サーバーURL。
PIWIK_IDMatomoサイトID。
PIWIK_SECRETMatomo認証トークン。

OpenCPU(R計算)

変数説明
OCPU_HOSTRベースの統計計算用OpenCPUサーバーURL。

RtBox統合

変数説明
RTBOX_HOSTRtBoxサービスのホストURL。
RTBOX_USER_APIRtBoxユーザーAPIキー。
RTBOX_BASIC_AUTHRtBoxの基本認証情報。

Matrixメッセージング

変数説明
MATRIX_HOMESERVER_HOSTMatrixホームサーバーのホスト。
MATRIX_HOMESERVER_PORTMatrixホームサーバーのポート。

データボリューム

すべてのアプリケーションデータは名前付きDockerボリュームに保存されます。ボリュームは初回起動時に自動的に作成され、コンテナの再起動や更新を通じて保持されます。

ボリュームマウントポイント内容
rtcloud_mysql_data/var/lib/mysqlMySQLデータベースファイル
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/smartsurveyShinyサーバー Rスクリプト
rtcloud_shiny_logs/var/log/shiny-serverShinyサーバーログ
rtcloud_assets…/assetsWebアセット(CSS、JS)
rtcloud_runtime…/protected/runtimeアプリケーションランタイムキャッシュ
rtcloud_cache…/cacheアプリケーションキャッシュ
rtcloud_tmp…/tmp一時ファイル

ボリューム名はCOMPOSE_PROJECT_NAMEの値(デフォルト:rtcloud)でプレフィックスされます。

デプロイのすべてのボリュームを一覧表示する:

  docker volume ls | grep rtcloud
  
このページは役に立ちましたか?