commit 66e6179aae
Author: Robert Kaussow <mail@thegeeklab.de> Date: Thu Feb 10 09:42:26 2022 +0100 refactor: modernize homeserver and logger config
This commit is contained in:
parent
7d667adcf2
commit
1411a9a743
113
index.md
113
index.md
@ -9,6 +9,7 @@ Setup a [matrix-synapse](https://github.com/matrix-org/synapse) chat server. Mat
|
|||||||
|
|
||||||
* [Default Variables](#default-variables)
|
* [Default Variables](#default-variables)
|
||||||
* [matrix_base_dir](#matrix_base_dir)
|
* [matrix_base_dir](#matrix_base_dir)
|
||||||
|
* [matrix_caches_global_factor](#matrix_caches_global_factor)
|
||||||
* [matrix_client_url](#matrix_client_url)
|
* [matrix_client_url](#matrix_client_url)
|
||||||
* [matrix_conf_dir](#matrix_conf_dir)
|
* [matrix_conf_dir](#matrix_conf_dir)
|
||||||
* [matrix_data_dir](#matrix_data_dir)
|
* [matrix_data_dir](#matrix_data_dir)
|
||||||
@ -18,15 +19,18 @@ Setup a [matrix-synapse](https://github.com/matrix-org/synapse) chat server. Mat
|
|||||||
* [matrix_db_server](#matrix_db_server)
|
* [matrix_db_server](#matrix_db_server)
|
||||||
* [matrix_db_ssl_mode](#matrix_db_ssl_mode)
|
* [matrix_db_ssl_mode](#matrix_db_ssl_mode)
|
||||||
* [matrix_db_ssl_root_cert](#matrix_db_ssl_root_cert)
|
* [matrix_db_ssl_root_cert](#matrix_db_ssl_root_cert)
|
||||||
|
* [matrix_db_txn_limit](#matrix_db_txn_limit)
|
||||||
* [matrix_db_type](#matrix_db_type)
|
* [matrix_db_type](#matrix_db_type)
|
||||||
* [matrix_db_user](#matrix_db_user)
|
* [matrix_db_user](#matrix_db_user)
|
||||||
|
* [matrix_default_room_version](#matrix_default_room_version)
|
||||||
|
* [matrix_event_cache_size](#matrix_event_cache_size)
|
||||||
* [matrix_extra_groups](#matrix_extra_groups)
|
* [matrix_extra_groups](#matrix_extra_groups)
|
||||||
* [matrix_filter_timeline_limit](#matrix_filter_timeline_limit)
|
* [matrix_filter_timeline_limit](#matrix_filter_timeline_limit)
|
||||||
* [matrix_form_secret](#matrix_form_secret)
|
* [matrix_form_secret](#matrix_form_secret)
|
||||||
* [matrix_group](#matrix_group)
|
* [matrix_group](#matrix_group)
|
||||||
* [matrix_http_bind_ips](#matrix_http_bind_ips)
|
* [matrix_http_bind_addresses](#matrix_http_bind_addresses)
|
||||||
* [matrix_http_bind_port](#matrix_http_bind_port)
|
* [matrix_http_bind_port](#matrix_http_bind_port)
|
||||||
* [matrix_https_bind_ips](#matrix_https_bind_ips)
|
* [matrix_https_bind_addresses](#matrix_https_bind_addresses)
|
||||||
* [matrix_https_bind_port](#matrix_https_bind_port)
|
* [matrix_https_bind_port](#matrix_https_bind_port)
|
||||||
* [matrix_ldap_auth_basedn](#matrix_ldap_auth_basedn)
|
* [matrix_ldap_auth_basedn](#matrix_ldap_auth_basedn)
|
||||||
* [matrix_ldap_auth_enabled](#matrix_ldap_auth_enabled)
|
* [matrix_ldap_auth_enabled](#matrix_ldap_auth_enabled)
|
||||||
@ -35,25 +39,24 @@ Setup a [matrix-synapse](https://github.com/matrix-org/synapse) chat server. Mat
|
|||||||
* [matrix_ldap_auth_server](#matrix_ldap_auth_server)
|
* [matrix_ldap_auth_server](#matrix_ldap_auth_server)
|
||||||
* [matrix_ldap_auth_uid_attr](#matrix_ldap_auth_uid_attr)
|
* [matrix_ldap_auth_uid_attr](#matrix_ldap_auth_uid_attr)
|
||||||
* [matrix_ldap_auth_use_starttls](#matrix_ldap_auth_use_starttls)
|
* [matrix_ldap_auth_use_starttls](#matrix_ldap_auth_use_starttls)
|
||||||
* [matrix_log_console_level](#matrix_log_console_level)
|
|
||||||
* [matrix_log_dir](#matrix_log_dir)
|
* [matrix_log_dir](#matrix_log_dir)
|
||||||
* [matrix_log_file_level](#matrix_log_file_level)
|
|
||||||
* [matrix_log_ldap_auth_level](#matrix_log_ldap_auth_level)
|
* [matrix_log_ldap_auth_level](#matrix_log_ldap_auth_level)
|
||||||
* [matrix_log_ldap_level](#matrix_log_ldap_level)
|
* [matrix_log_ldap_level](#matrix_log_ldap_level)
|
||||||
|
* [matrix_log_root_level](#matrix_log_root_level)
|
||||||
* [matrix_log_synapse_level](#matrix_log_synapse_level)
|
* [matrix_log_synapse_level](#matrix_log_synapse_level)
|
||||||
* [matrix_log_synapse_sql_level](#matrix_log_synapse_sql_level)
|
* [matrix_log_synapse_sql_level](#matrix_log_synapse_sql_level)
|
||||||
* [matrix_macaroon_secret_key](#matrix_macaroon_secret_key)
|
* [matrix_macaroon_secret_key](#matrix_macaroon_secret_key)
|
||||||
* [matrix_packages](#matrix_packages)
|
* [matrix_packages](#matrix_packages)
|
||||||
* [matrix_packages_extra](#matrix_packages_extra)
|
* [matrix_packages_extra](#matrix_packages_extra)
|
||||||
|
* [matrix_presence_enabled](#matrix_presence_enabled)
|
||||||
* [matrix_rc_login_account](#matrix_rc_login_account)
|
* [matrix_rc_login_account](#matrix_rc_login_account)
|
||||||
* [matrix_rc_login_address](#matrix_rc_login_address)
|
* [matrix_rc_login_address](#matrix_rc_login_address)
|
||||||
* [matrix_restart_policy](#matrix_restart_policy)
|
* [matrix_restart_policy](#matrix_restart_policy)
|
||||||
* [matrix_server_url](#matrix_server_url)
|
* [matrix_server_url](#matrix_server_url)
|
||||||
* [matrix_signing_key](#matrix_signing_key)
|
* [matrix_signing_key](#matrix_signing_key)
|
||||||
|
* [matrix_suppress_key_server_warning](#matrix_suppress_key_server_warning)
|
||||||
* [matrix_tls_cert_path](#matrix_tls_cert_path)
|
* [matrix_tls_cert_path](#matrix_tls_cert_path)
|
||||||
* [matrix_tls_cert_source](#matrix_tls_cert_source)
|
* [matrix_tls_cert_source](#matrix_tls_cert_source)
|
||||||
* [matrix_tls_dhparam_path](#matrix_tls_dhparam_path)
|
|
||||||
* [matrix_tls_dhparam_size](#matrix_tls_dhparam_size)
|
|
||||||
* [matrix_tls_enabled](#matrix_tls_enabled)
|
* [matrix_tls_enabled](#matrix_tls_enabled)
|
||||||
* [matrix_tls_key_path](#matrix_tls_key_path)
|
* [matrix_tls_key_path](#matrix_tls_key_path)
|
||||||
* [matrix_tls_key_source](#matrix_tls_key_source)
|
* [matrix_tls_key_source](#matrix_tls_key_source)
|
||||||
@ -79,6 +82,14 @@ Setup a [matrix-synapse](https://github.com/matrix-org/synapse) chat server. Mat
|
|||||||
matrix_base_dir: /opt/matrix
|
matrix_base_dir: /opt/matrix
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### matrix_caches_global_factor
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
matrix_caches_global_factor: 0.5
|
||||||
|
```
|
||||||
|
|
||||||
### matrix_client_url
|
### matrix_client_url
|
||||||
|
|
||||||
#### Default value
|
#### Default value
|
||||||
@ -151,6 +162,14 @@ matrix_db_ssl_mode: disable
|
|||||||
matrix_db_ssl_root_cert: /etc/pki/tls/certs/ca-bundle.trust.crt
|
matrix_db_ssl_root_cert: /etc/pki/tls/certs/ca-bundle.trust.crt
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### matrix_db_txn_limit
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
matrix_db_txn_limit: 0
|
||||||
|
```
|
||||||
|
|
||||||
### matrix_db_type
|
### matrix_db_type
|
||||||
|
|
||||||
Sopported values are `pgsql` and `sqlite`.
|
Sopported values are `pgsql` and `sqlite`.
|
||||||
@ -169,6 +188,22 @@ matrix_db_type: pgsql
|
|||||||
matrix_db_user: pgmatrix
|
matrix_db_user: pgmatrix
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### matrix_default_room_version
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
matrix_default_room_version: '6'
|
||||||
|
```
|
||||||
|
|
||||||
|
### matrix_event_cache_size
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
matrix_event_cache_size: 100K
|
||||||
|
```
|
||||||
|
|
||||||
### matrix_extra_groups
|
### matrix_extra_groups
|
||||||
|
|
||||||
#### Default value
|
#### Default value
|
||||||
@ -201,12 +236,12 @@ matrix_form_secret: oFP3m&,r^wJ=Tr#=Ruww5+h0e;-DZqcuVGXV4XgRZIAt~Gv2YF
|
|||||||
matrix_group: '{{ matrix_user }}'
|
matrix_group: '{{ matrix_user }}'
|
||||||
```
|
```
|
||||||
|
|
||||||
### matrix_http_bind_ips
|
### matrix_http_bind_addresses
|
||||||
|
|
||||||
#### Default value
|
#### Default value
|
||||||
|
|
||||||
```YAML
|
```YAML
|
||||||
matrix_http_bind_ips:
|
matrix_http_bind_addresses:
|
||||||
- 127.0.0.1
|
- 127.0.0.1
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -218,12 +253,12 @@ matrix_http_bind_ips:
|
|||||||
matrix_http_bind_port: 8008
|
matrix_http_bind_port: 8008
|
||||||
```
|
```
|
||||||
|
|
||||||
### matrix_https_bind_ips
|
### matrix_https_bind_addresses
|
||||||
|
|
||||||
#### Default value
|
#### Default value
|
||||||
|
|
||||||
```YAML
|
```YAML
|
||||||
matrix_https_bind_ips: []
|
matrix_https_bind_addresses: []
|
||||||
```
|
```
|
||||||
|
|
||||||
### matrix_https_bind_port
|
### matrix_https_bind_port
|
||||||
@ -290,14 +325,6 @@ matrix_ldap_auth_uid_attr: uid
|
|||||||
matrix_ldap_auth_use_starttls: 'false'
|
matrix_ldap_auth_use_starttls: 'false'
|
||||||
```
|
```
|
||||||
|
|
||||||
### matrix_log_console_level
|
|
||||||
|
|
||||||
#### Default value
|
|
||||||
|
|
||||||
```YAML
|
|
||||||
matrix_log_console_level: ERROR
|
|
||||||
```
|
|
||||||
|
|
||||||
### matrix_log_dir
|
### matrix_log_dir
|
||||||
|
|
||||||
#### Default value
|
#### Default value
|
||||||
@ -306,14 +333,6 @@ matrix_log_console_level: ERROR
|
|||||||
matrix_log_dir: '{{ matrix_base_dir }}/log'
|
matrix_log_dir: '{{ matrix_base_dir }}/log'
|
||||||
```
|
```
|
||||||
|
|
||||||
### matrix_log_file_level
|
|
||||||
|
|
||||||
#### Default value
|
|
||||||
|
|
||||||
```YAML
|
|
||||||
matrix_log_file_level: INFO
|
|
||||||
```
|
|
||||||
|
|
||||||
### matrix_log_ldap_auth_level
|
### matrix_log_ldap_auth_level
|
||||||
|
|
||||||
#### Default value
|
#### Default value
|
||||||
@ -330,6 +349,14 @@ matrix_log_ldap_auth_level: INFO
|
|||||||
matrix_log_ldap_level: INFO
|
matrix_log_ldap_level: INFO
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### matrix_log_root_level
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
matrix_log_root_level: INFO
|
||||||
|
```
|
||||||
|
|
||||||
### matrix_log_synapse_level
|
### matrix_log_synapse_level
|
||||||
|
|
||||||
#### Default value
|
#### Default value
|
||||||
@ -384,6 +411,14 @@ matrix_packages:
|
|||||||
matrix_packages_extra: []
|
matrix_packages_extra: []
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### matrix_presence_enabled
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
matrix_presence_enabled: false
|
||||||
|
```
|
||||||
|
|
||||||
### matrix_rc_login_account
|
### matrix_rc_login_account
|
||||||
|
|
||||||
Ratelimiting settings for login requests based on the account the client is attempting to log into.
|
Ratelimiting settings for login requests based on the account the client is attempting to log into.
|
||||||
@ -432,6 +467,14 @@ matrix_server_url: example.com
|
|||||||
matrix_signing_key: _unset_
|
matrix_signing_key: _unset_
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### matrix_suppress_key_server_warning
|
||||||
|
|
||||||
|
#### Default value
|
||||||
|
|
||||||
|
```YAML
|
||||||
|
matrix_suppress_key_server_warning: false
|
||||||
|
```
|
||||||
|
|
||||||
### matrix_tls_cert_path
|
### matrix_tls_cert_path
|
||||||
|
|
||||||
#### Default value
|
#### Default value
|
||||||
@ -448,22 +491,6 @@ matrix_tls_cert_path: '{{ matrix_base_dir }}/tls/certs/mycert.pem'
|
|||||||
matrix_tls_cert_source: mycert.pem
|
matrix_tls_cert_source: mycert.pem
|
||||||
```
|
```
|
||||||
|
|
||||||
### matrix_tls_dhparam_path
|
|
||||||
|
|
||||||
#### Default value
|
|
||||||
|
|
||||||
```YAML
|
|
||||||
matrix_tls_dhparam_path: '{{ matrix_base_dir }}/tls/dhparam.pem'
|
|
||||||
```
|
|
||||||
|
|
||||||
### matrix_tls_dhparam_size
|
|
||||||
|
|
||||||
#### Default value
|
|
||||||
|
|
||||||
```YAML
|
|
||||||
matrix_tls_dhparam_size: 2048
|
|
||||||
```
|
|
||||||
|
|
||||||
### matrix_tls_enabled
|
### matrix_tls_enabled
|
||||||
|
|
||||||
#### Default value
|
#### Default value
|
||||||
@ -525,7 +552,7 @@ matrix_user_home: /home/{{ matrix_user }}
|
|||||||
#### Default value
|
#### Default value
|
||||||
|
|
||||||
```YAML
|
```YAML
|
||||||
matrix_version: 1.26.0
|
matrix_version: 1.52.0
|
||||||
```
|
```
|
||||||
|
|
||||||
### matrix_virtualenv
|
### matrix_virtualenv
|
||||||
|
Loading…
Reference in New Issue
Block a user