Mirrors/ansible-collection-famedly-matrix
2
0
Fork 0
mirror of https://github.com/famedly/ansible-collection-matrix synced 2024-12-05 00:59:15 +00:00
Code Issues Projects Releases Packages Wiki Activity

Start fixing variables, paths and defaults

Browse source 
Still WIP
This commit is contained in:
Emmanouil Kampitakis 2019-02-12 03:14:30 +01:00
parent 7635784748
commit 7028d8373b
3 changed files with 34 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -1,10 +1,8 @@
matrix-synapse
==============
# matrix-synapse
Install a matrix synapse server.
Requirements
------------
## Requirements
The following should be present on the target system
* `pip`
@ -12,54 +10,62 @@ The following should be present on the target system
* `rsyslogd`
* `logrotate`
Role Variables
--------------
## Role Variables
__Default vars__
### Mandatory Variables
| Name | Type | Description |
| :--- | :--- | :--- |
| **matrix_server_name** | __string__ | |
| **matrix_synapse_tls_cert** | __string__ | server's TLS certificate chain |
| **matrix_synapse_tls_key** | __string__ | server's TLS key |
| **matrix_synapse_report_stats** | __bool__ | Report the stats to matrix.org |
### Optional Variables
| Name | Value |
| :--- | :--- |
| matrix_synapse_tls_path | "/opt/synapse/ssl/{{ matrix_synapse_domain }}.crt" |
| matrix_synapse_key_path | "/opt/synapse/ssl/{{ matrix_synapse_domain }}.key" |
| matrix_synapse_dh_path | "/opt/synapse/ssl/{{ matrix_synapse_domain }}.dh" |
| matrix_synapse_server_name | "{{ matrix_synapse_domain }}" |
| matrix_synapse_baseurl | "https://{{ matrix_synapse_domain }}" |
| matrix_synapse_port_prefix | 100 |
| matrix_synapse_tls_cert_path | "/opt/synapse/tls/{{ matrix_server_name }}.crt" |
| matrix_synapse_tls_key_path | "/opt/synapse/tls/{{ matrix_server_name }}.key" |
| matrix_synapse_dh_path | "/opt/synapse/tls/{{ matrix_server_name }}.dh" |
| matrix_synapse_server_name | "{{ matrix_server_name }}" |
| matrix_synapse_baseurl | "https://{{ matrix_server_name }}" |
| matrix_synapse_pg_pass | "{{ matrix_pg_pass }}" |
| matrix_synapse_pg_user | "{{ matrix_pg_user }}" |
| matrix_synapse_pg_db | "{{ matrix_pg_db }}" |
| matrix_synapse_pg_host | "{{ matrix_pg_host }}" |
| matrix_synapse_log_config | "/opt/synapse/{{ matrix_synapse_domain }}.log.config" |
| matrix_synapse_log_config | "/opt/synapse/{{ matrix_server_name }}.log.config" |
| matrix_synapse_media_store_path | "/opt/synapse/media_store" |
| matrix_synapse_uploads_path | "/opt/synapse/uploads" |
| matrix_synapse_turn_secret | "{{ matrix_turn_secret }}" |
| matrix_synapse_turn_uri | "{{ matrix_turn_uri }}" |
| matrix_synapse_registration_secret | "{{ matrix_registration_secret }}" |
| matrix_synapse_macaroon_secret_key | "{{ matrix_macaroon_key }}" |
| matrix_synapse_signing_key_path | "/opt/synapse/ssl/{{ matrix_synapse_domain }}.signing.key" |
| matrix_synapse_signing_key_path | "/opt/synapse/ssl/{{ matrix_server_name }}.signing.key" |
| matrix_synapse_version | "v0.34.1.1" |
| matrix_synapse_log_days_keep | 30 |
| matrix_synapse_skip_ssl | false |
| matrix_synapse_pid_file | /opt/synapse/synapse.pid |
| matrix_synapse_manhole | false |
| matrix_synapse_max_upload_size | 23M |
| matrix_synapse_url_preview_enabled | true |
| matrix_sybapse_registration_secret | __randomly generated__ |
Dependencies
------------
## Dependencies
__None__.
Example Playbook
----------------
## Example Playbook
```yaml
#TODO: Add example
```
License
-------
## License
Apache 2.0
Author Information
------------------
# Author Information
* Michael Kaye
* Jan Christian Grünhage

1
TODO.md
View file

@ -1 +1,2 @@
* **URGENT** Clean up the variables in README vs. "template" vs. defaults etc.
* Create the signing key (tasks/ssl.yml) with openssl rather than inline python 🤮

9
defaults/main.yml
View file

@ -1,10 +1,9 @@
---
matrix_synapse_tls_path: "/opt/synapse/ssl/{{ matrix_synapse_domain }}.crt"
matrix_synapse_key_path: "/opt/synapse/ssl/{{ matrix_synapse_domain }}.key"
matrix_synapse_dh_path: "/opt/synapse/ssl/{{ matrix_synapse_domain }}.dh"
matrix_synapse_tls_cert_path: "/opt/synapse/tls/{{ matrix_synapse_domain }}.crt"
matrix_synapse_tls_key_path: "/opt/synapse/tls/{{ matrix_synapse_domain }}.key"
matrix_synapse_dh_path: "/opt/synapse/tls/{{ matrix_synapse_domain }}.dh"
matrix_synapse_server_name: "{{ matrix_synapse_domain }}"
matrix_synapse_baseurl: "https://{{ matrix_synapse_domain }}"
matrix_synapse_port_prefix: 100
matrix_synapse_pg_pass: "{{ matrix_pg_pass }}"
matrix_synapse_pg_user: "{{ matrix_pg_user }}"
matrix_synapse_pg_db: "{{ matrix_pg_db }}"
@ -16,7 +15,7 @@ matrix_synapse_turn_secret: "{{ matrix_turn_secret }}"
matrix_synapse_turn_uri: "{{ matrix_turn_uri }}"
matrix_synapse_registration_secret: "{{ matrix_registration_secret }}"
matrix_synapse_macaroon_secret_key: "{{ matrix_macaroon_key }}"
matrix_synapse_signing_key_path: "/opt/synapse/ssl/{{ matrix_synapse_domain }}.signing.key"
matrix_synapse_signing_key_path: "/opt/synapse/tls/{{ matrix_synapse_domain }}.signing.key"
matrix_synapse_version: "v0.34.1.1"
matrix_synapse_log_days_keep: 30
matrix_synapse_skip_ssl: false