On this page
settings
設定リファレンス
セルフホストrtCloudデプロイの設定に使用するすべての環境変数の完全なリファレンス。
すべての設定はデプロイディレクトリのルートにある.envファイル内の環境変数で行います。Docker Composeはこのファイルを自動的に読み込みます — --env-fileフラグは不要です。
必須と記載された変数はコンテナを起動する前に設定する必要があります。その他はデフォルト値があり、オプションです。
プロジェクト
これらの変数はrtCloudインスタンスのIDとアクセスポイントを定義します。
| 変数 | デフォルト | 必須 | 説明 |
|---|---|---|---|
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の構築に使用するプロトコル。SSLを使用しない場合はhttpに設定する。 |
データベース
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ユーザーのパスワード。初回起動前に設定する。データベースがすでに存在する場合は効果がない。 |
初回ログイン後、Web UIのアカウント設定ページから管理者パスワードを変更してください。
ポート
アプリケーションがバインドするホストポートを制御します。
| 変数 | デフォルト | 説明 |
|---|---|---|
APP_PORT | 8080 | メインWeb UI用のホストポート。ポート8080がサーバーで既に使用されている場合は変更する。 |
SHINY_PORT | 3838 | Shiny分析サーバー用のホストポート。 |
ランタイム
| 変数 | デフォルト | 説明 |
|---|---|---|
RUN_ENV | prod | ランタイム環境。本番デプロイにはprod、ローカル開発にはdevを使用する。 |
RUN_MODE | admin | コンテナのロール。adminはフルスタック(Web + キュー + 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のままにする。400 CSRF token could not be verifiedエラーが発生する場合のみ、ローカル開発ではfalseに設定する。 |
GII_ENABLED | false | Yiiフレームワークのコードジェネレーターツールを有効にする。本番環境では絶対に有効にしないこと。 |
SSO — 組み込みKeycloak
エンタープライズSSOのフル機能のための組み込みKeycloakコンテナを有効にする。HTTPSを持つドメインが必要。
| 変数 | デフォルト | 説明 |
|---|---|---|
EMBED_KEYCLOAK | false | 組み込みKeycloakコンテナを起動するにはtrueに設定する。embed-keycloak Docker Composeプロファイルを有効にする。 |
KEYCLOAK_URL | — | KeycloakサーバーのフルURL(例:https://rtcloud.example.com/auth)。 |
KEYCLOAK_REALM | — | Keycloakレルム名(例:rtsurvey)。 |
KEYCLOAK_CLIENT_ID | — | rtCloudアプリケーション用のKeycloakクライアントID。 |
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 | — | KeycloakフロントエンドURL(例:https://rtcloud.example.com/auth)。 |
KC_HOSTNAME_STRICT | false | 厳密なホスト名マッチングを適用する。固定ドメインを持つ本番環境ではtrueに設定する。 |
完全なセットアップガイドについてはSSO認証を参照してください。
SSO — 外部OIDCプロバイダー
既存のOIDC互換IDプロバイダー(Supabase、Auth0、Authentik、Oktaなど)にrtCloudを接続する。
| 変数 | デフォルト | 説明 |
|---|---|---|
OIDC_ISSUER_URL | — | OIDCイシュアー検出URL(例:https://accounts.google.com)。 |
OIDC_CLIENT_ID | — | IDプロバイダーに登録されたクライアントID。 |
OIDC_CLIENT_SECRET | — | IDプロバイダーのクライアントシークレット。 |
OIDC_SCOPE | openid profile email | 要求するOIDCスコープのスペース区切りリスト。 |
OIDC_REDIRECT_URI | — | Webアプリのコールバック URL(例:https://rtcloud.example.com/auth/callback)。 |
OIDC_MOBILE_CLIENT_ID | — | rtSurveyモバイルアプリ用の個別クライアントID。 |
OIDC_MOBILE_REDIRECT_URI | — | モバイルアプリのコールバックURI(例:vn.rta.rtsurvey.auth://callback)。 |
OPEN_REGISTRATION | false | OIDCを通じて初めて認証したユーザーのrtCloudアカウントを自動作成する。 |
OIDC_AUTHORIZATION_ENDPOINT | — | 認証エンドポイントURLを上書きする(検出を使用する場合は空白)。 |
OIDC_TOKEN_ENDPOINT | — | トークンエンドポイントURLを上書きする(検出を使用する場合は空白)。 |
OIDC_USERINFO_ENDPOINT | — | ユーザー情報エンドポイントURLを上書きする(検出を使用する場合は空白)。 |
SSO — Azure Active Directory
| 変数 | 説明 |
|---|---|
AZURE_CLIENT_ID | Azure ADアプリケーション(クライアント)ID。 |
AZURE_TENANT_ID | Azure ADディレクトリ(テナント)ID。 |
オプション統合
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 | Matomo(Piwik)サーバーURL。 |
PIWIK_ID | MatomoサイトID。 |
PIWIK_SECRET | Matomo認証トークン。 |
OpenCPU(R計算)
| 変数 | 説明 |
|---|---|
OCPU_HOST | Rベースの統計計算用OpenCPUサーバーURL。 |
RtBox統合
| 変数 | 説明 |
|---|---|
RTBOX_HOST | RtBoxサービスのホストURL。 |
RTBOX_USER_API | RtBoxユーザーAPIキー。 |
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 | Shinyサーバー Rスクリプト |
rtcloud_shiny_logs | /var/log/shiny-server | Shinyサーバーログ |
rtcloud_assets | …/assets | Webアセット(CSS、JS) |
rtcloud_runtime | …/protected/runtime | アプリケーションランタイムキャッシュ |
rtcloud_cache | …/cache | アプリケーションキャッシュ |
rtcloud_tmp | …/tmp | 一時ファイル |
ボリューム名はCOMPOSE_PROJECT_NAMEの値(デフォルト:rtcloud)でプレフィックスされます。
デプロイのすべてのボリュームを一覧表示する:
docker volume ls | grep rtcloud
このページは役に立ちましたか?