これは、セルフホスト型 Discourse インストールで環境変数を設定するための how-to ガイドです。
必要なユーザーレベル: 管理者
環境変数は、Discourse インスタンスの設定において重要な役割を果たします。API キーやデータベースパスワードなどの機密データを格納できるため、インストールをより安全で柔軟にすることができます。Discourse では、環境変数は Docker コンテナ設定内の app.yml ファイルで設定されます。
.yml (YAML) ファイルに環境変数を追加するのは簡単です。基本的な例を次に示します。
# これは環境変数を含む YAML ファイルです
env:
VARIABLE_NAME: "Variable Value"
ANOTHER_VARIABLE: "Another Value"
Discourse Docker コンテナのコンテキストでは、環境変数は app.yml ファイルの env セクションに格納されます。
app.yml ファイルの例を次に示します:
## これはスタンドアロンの Discourse Docker コンテナテンプレートです
##
## このファイルを変更した後は、再構築する必要があります
## /var/discourse/launcher rebuild app
##
templates:
- "templates/postgres.template.yml"
- "templates/redis.template.yml"
- "templates/web.template.yml"
- "templates/web.ratelimited.template.yml"
## HTTPS の Let's Encrypt を追加したい場合は、これらの 2 行をコメント解除してください
#- "templates/web.ssl.template.yml"
#- "templates/web.letsencrypt.ssl.template.yml"
## このコンテナはどの TCP/IP ポートを公開しますか？
## Apache や nginx のような他の Web サーバーとポートを共有したい場合は、
## https://meta.discourse.org/t/17247 を参照してください
expose:
- "80:80" # http
- "443:443" # https
params:
db_default_text_search_config: "pg_catalog.english"
## db_shared_buffers を合計メモリの最大 25% に設定します。
## ブートストラップによって検出された RAM に基づいて自動的に設定されますが、オーバーライドすることもできます
db_shared_buffers: "256MB"
env:
LANG: en_US.UTF-8
# DISCOURSE_DEFAULT_LOCALE: en
## 同時に処理できる Web リクエスト数はいくつですか？メモリと CPU コアに依存します。
## ブートストラップによって検出された CPU に基づいて自動的に設定されますが、オーバーライドすることもできます
UNICORN_WORKERS: 3
## TODO: この Discourse インスタンスが応答するドメイン名
DISCOURSE_HOSTNAME: 'discourse.example.com'
## コンテナを上記で指定されたものと同じホスト名 (-h オプション) で起動したい場合は、コメント解除してください (デフォルトは "$hostname-$config")
#DOCKER_USE_HOSTNAME: true
## TODO: 初期サインアップ時に管理者および開発者になるメールアドレスのカンマ区切りリスト
## 例: 'user1@example.com,user2@example.com'
DISCOURSE_DEVELOPER_EMAILS: 'user@example.com'
## TODO: 新規アカウントの検証や通知の送信に使用される SMTP メールサーバー
DISCOURSE_SMTP_ADDRESS: smtp.example.com # (必須)
DISCOURSE_SMTP_PORT: 587 # (オプション)
DISCOURSE_SMTP_USER_NAME: user@example.com # (オプション)
DISCOURSE_SMTP_PASSWORD: a_s3cr3t_p@ssword # (オプション)
#DISCOURSE_SMTP_ENABLE_START_TLS: true # (オプション、デフォルトは true)
## Let's Encrypt テンプレートを追加した場合は、無料 SSL 証明書を取得するために以下をコメント解除してください
#LETSENCRYPT_ACCOUNT_EMAIL: me@example.com
## この Discourse インスタンスの CDN アドレス (プル用に設定)
#DISCOURSE_CDN_URL: //discourse-cdn.example.com
## Docker コンテナはステートレスです。すべてのデータは /shared に格納されます
volumes:
- volume:
host: /var/discourse/shared/standalone
guest: /shared
- volume:
host: /var/discourse/shared/standalone/log/var-log
guest: /var/log
## プラグインはここに配置します
## https://meta.discourse.org/t/19157 を参照してください
hooks:
after_code:
- exec:
cd: $home/plugins
cmd:
- git clone https://github.com/discourse/docker_manager.git
## ビルド後に実行するカスタムコマンド
run:
- exec: echo "カスタムコマンドを開始します"
## 初回登録の「差出人」メールアドレスを設定したい場合は、コメント解除して変更してください:
#- exec: rails r "SiteSetting.notification_email='info@unconfigured.discourse.org'"
## 初回サインアップメールを受け取った後、行を再度コメントアウトしてください。一度だけ実行する必要があります。
- exec: echo "カスタムコマンドを終了します"
サイトに環境変数を追加しましょう！
以下の手順は、標準 Discourse インストール向けに記述されています。
サーバーにログインする
PuTTY のようなツールや Unix 系システムのターミナルを使用して、サーバーに SSH 接続します。
ssh username@your-server-ip
Discourse ディレクトリに移動する
サーバーにアクセスしたら、Discourse Docker セットアップが含まれるディレクトリに移動します。通常は /var/discourse にあります。
cd /var/discourse
app.yml ファイルを開く
テキストエディタで app.yml ファイルを開く必要があります。この例では nano を使用します。
nano containers/app.yml
環境変数を追加する
app.yml ファイルには env セクションがあります。ここに環境変数を追加できます。
env:
DISCOURSE_HOSTNAME: 'discourse.example.com'
DISCOURSE_SMTP_ADDRESS: smtp.example.com
DISCOURSE_SMTP_PORT: 587
DISCOURSE_SMTP_USER_NAME: user@example.com
DISCOURSE_SMTP_PASSWORD: a_s3cr3t_p@ssword
たとえば、Cross-Origin Resource Sharing (CORS) を有効にするために DISCOURSE_ENABLE_CORS 環境変数を true に設定したい場合は、次の行を env セクションに追加します。
env:
DISCOURSE_ENABLE_CORS: "true"
...
ここでの空白とフォーマットは重要なので、新しい行の正しいインデント (スペース 2 つ) を維持するようにしてください。
変数を変更したら、ファイルを保存して閉じます。
Discourse コンテナを再構築する
最後に、変更を有効にするために Discourse Docker コンテナを再構築する必要があります。次のコマンドで実行できます。
./launcher rebuild app
または、再構築せずに実行中のコンテナの環境変数を更新するには、次を使用することもできます。
./launcher destroy app
./launcher start app
再構築プロセスが完了すると、更新された環境変数が Discourse アプリケーションで使用できるようになります！
