atb00ker.matrix-synapse
ansible-matrix-synapse
注意：这个项目不再维护，现在有更好的解决方案和官方的 docker 镜像可用。
这段代码将会在你的服务器上安装 matrix-synapse，并为你的域名从 letsencrypt.org 获取证书，并设置定时任务来自动更新证书。
可选地，安装并配置 postgresSQL 与 matrix-synapse。
如何运行
- 安装 Ansible
- 在清单文件中添加你的服务器组。
- 将
hosts从all改为你要安装 matrix-synapse 的服务器组。（在文件 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 | 你计划设置 homeserver 的服务器域名 |
| 字符串 | email: YOUR_AWESOME@EMAIL.ID | 如果你打算使用 letsencrypt 进行 https（安全）连接，则需要提供邮箱 |
高级更改
| 变量名 | 有效值 | 示例 | 备注 |
|---|---|---|---|
| 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 | NUMBER | synapseCacheFactor: 0.2 | matrix-synapse 允许使用的内存量，了解更多 |
PostgreSQL 设置
| 变量名 | 有效值 | 示例 | 备注 |
|---|---|---|---|
| portForClient | PORT NUMBER | portForClient: 443 | 你将在域名上使用此端口来创建 homeserver |
| 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 | 这将是你的数据库的 postgresSQL 用户名 |
| postgresPassword | 字符串 | postgresUser: 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/
欢迎在此仓库贡献或提出问题。