atb00ker.matrix-synapse
ansible-matrix-synapse
ПРИМЕЧАНИЕ: Не поддерживается, сейчас есть лучшие решения и официальные образы Docker.
Этот код установит matrix-synapse на вашем сервере, получит сертификаты от letsencrypt.org для вашего домена и настроит задание cron для их автоматического обновления. При желании можно установить и настроить PostgreSQL вместе с 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 | Установите true, если вы хотите разрешить пользователям самостоятельно регистрироваться через клиенты, такие как riot.im. Установите false в противном случае |
| reportStats | true/false | reportStats: false | Отправлять анонимные отчёты о статистике для улучшения кода matrix. Для получения дополнительной информации посетите: matrix.org |
| nginxConfFile | ПУТЬ/К/ФАЙЛУ | nginxConfFile: nginx.j2 | Это конфигурационный файл nginx, который будет отправлен на сервер |
| synapseCacheFactor | ЧИСЛО | synapseCacheFactor: 0.2 | Количество оперативной памяти, разрешенной для использования matrix-synapse читайте подробнее |
Настройки PostgreSQL
| Переменная | Допустимые значения | Пример | Примечание |
|---|---|---|---|
| portForClient | НОМЕР ПОРТА | portForClient: 443 | Вы будете использовать этот порт для вашего homeserver |
| postgresEnable | true/false | postgresEnable: true | Установите это на true, если хотите использовать PostgreSQL как систему управления базами данных и на false, если планируете использовать SQLite |
| postgresConfig | true/false | postgresConfig: true | Установите это на true, если хотите настроить PostgreSQL на том же сервере, и на false, если у вас уже настроен другой сервер базы данных, и вы хотите просто настроить Matrix с хостом, пользователем, паролем и именем базы данных этого сервера |
| postgresHost | строка | postgresHost: localhost | Адрес хоста для вашего сервера базы данных |
| postgresUser | строка | postgresUser: YOUR_AWESOME_USER | Это будет роль/пользователь PostgreSQL вашей базы данных |
| postgresPassword | строка | postgresUser: YOUR_AWESOME_PASSWORD | Это будет пароль для вашей роли/пользователя |
| postgresDatabase | строка | postgresDatabase: YOUR_AWESOME_DATABASE | Это будет основная база данных для matrix |
| postgresConfFile | ПУТЬ/К/ФАЙЛУ | 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/
Не стесняйтесь внести свой вклад в этот репозиторий или открыть проблему.
О проекте
Install matrix-synapse homeserver (Setup Personal homeserver for clients like riot.im)
Установить
ansible-galaxy install atb00ker.matrix-synapseЛицензия
gpl-3.0
Загрузки
122
Владелец
