atb00ker.matrix-synapse
ansible-matrix-synapse
注意: メンテナンスされていません。現在はより良い解決策があり、公式のDockerイメージも利用可能です。
このコードは、あなたのサーバーにmatrix-synapseをインストールし、あなたのドメイン用にletsencrypt.orgから証明書を取得し、証明書を更新するためのcronジョブを設定します。
オプションとして、matrix-synapseと一緒にPostgreSQLをインストールして設定することもできます。
実行方法
- Ansibleをインストールします。
- インベントリにサーバーグループを追加します。
- matrix-synapseをインストールしたいサーバーグループに
hostsをallから変更します。（ファイル: ansible-matrix-synapse/main.yaml）[オプション; 要件に応じて] remote_userをrootからsudo権限を持つユーザーに変更します。（ファイル: ansible-matrix-synapse/main.yaml）[オプション; 要件に応じて]- インストールのために設定したい変数を確認します。（ファイル: ansible-matrix-synapse/defaults/main.yml）
必ず変更するべき項目
| 変数名 | 有効な値 | 例 | 注意 |
|---|---|---|---|
| hostname | 文字列 | hostname: www.MY_AWESOME_WEBSITE.com | ホームサーバーを設定するドメイン |
| 文字列 | email: YOUR_AWESOME@EMAIL.ID | HTTPS（安全）接続にletsencryptを使用する場合に必要なメール |
高度な変更
| 変数名 | 有効な値 | 例 | 注意 |
|---|---|---|---|
| enableRegistration | true/false | enableRegistration: true | ユーザーがriot.imのようなクライアントを使って自分で登録できるようにしたい場合はtrueに設定、そうでない場合はfalse |
| reportStats | true/false | reportStats: false | 匿名で統計を報告し、matrixの改善をサポートする。詳細はmatrix.orgを訪れてください。 |
| nginxConfFile | PATH/TO/FILE | nginxConfFile: nginx.j2 | サーバーに送信されるnginx設定ファイル |
| synapseCacheFactor | 数値 | synapseCacheFactor: 0.2 | matrix-synapseが使用できるRAMの量、詳しくはこちら |
PostgreSQL設定
| 変数名 | 有効な値 | 例 | 注意 |
|---|---|---|---|
| portForClient | ポート番号 | portForClient: 443 | ホームサーバー用のドメインで使用するポート |
| postgresEnable | true/false | postgresEnable: true | PostgreSQLをデータベース管理システムとして使用する場合はtrue、SQLiteを使用する場合はfalse |
| postgresConfig | true/false | postgresConfig: true | 同じサーバーにPostgreSQLを設定する場合はtrue、異なるデータベースサーバーがすでにある場合はfalse |
| postgresHost | 文字列 | postgresHost: localhost | データベースサーバーのホストアドレス |
| postgresUser | 文字列 | postgresUser: YOUR_AWESOME_USER | データベースのPostgreSQLロール/ユーザー |
| postgresPassword | 文字列 | postgresPassword: YOUR_AWESOME_PASSWORD | ロール/ユーザーのパスワード |
| postgresDatabase | 文字列 | postgresDatabase: YOUR_AWESOME_DATABASE | matrixのメインデータベース |
| postgresConfFile | PATH/TO/FILE | postgresConfFile: database.yml.js | PostgreSQLを有効にするための設定ファイル |
- 次のコマンドを実行します（ansible-matrix-synapseフォルダー内から）:
ansible-playbook main.yaml --ask-become
テスト済み:
- Ubuntu Xenial (16.04)
最小要件:
- ansible >=2.0
参考:
- Ansible: https://www.ansible.com
- Matrix: https://matrix.org/
- letsencrypt: https://letsencrypt.org/
このリポジトリに貢献するか、問題をオープンすることを自由に行ってください。