From 64370cb58b13294d8bd544266153e1e6930ef7ea Mon Sep 17 00:00:00 2001 From: fnoah Date: Tue, 22 Oct 2019 09:54:13 +0200 Subject: [PATCH] Fix formatting issues --- docs/configuring-playbook-mxisd.md | 15 ++++++++++----- docs/maintenance-and-troubleshooting.md | 6 +++--- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/docs/configuring-playbook-mxisd.md b/docs/configuring-playbook-mxisd.md index 957f9466..2f5806bb 100644 --- a/docs/configuring-playbook-mxisd.md +++ b/docs/configuring-playbook-mxisd.md @@ -4,6 +4,7 @@ By default, this playbook configures an [mxisd](https://github.com/kamax-io/mxis This server is private by default, potentially at the expense of user discoverability. + ## Matrix.org lookup forwarding To ensure maximum discovery, you can make your identity server also forward lookups to the central matrix.org Identity server (at the cost of potentially leaking all your contacts information). @@ -16,22 +17,25 @@ Enabling matrix.org forwarding can happen with the following configuration: matrix_mxisd_matrixorg_forwarding_enabled: true ``` + ## Customizing email templates If you'd like to change the default email templates used by mxisd, take a look at the `matrix_mxisd_threepid_medium_email_custom_` variables (in the `roles/matrix-mxisd/defaults/main.yml` file. + ## mxisd-controlled Registration To use the [Registration](https://github.com/kamax-matrix/mxisd/blob/master/docs/features/registration.md) feature of mxisd, you can make use of the following variables: -- `matrix_synapse_enable_registration` - to enable user-initiated registration in Synapse +- `matrix_synapse_enable_registration` - to enable user-initiated registration in Synapse -- `matrix_synapse_registrations_require_3pid` - to control the types of 3pid (`'email'`, `'msisdn'`) required by the Synapse server for registering +- `matrix_synapse_registrations_require_3pid` - to control the types of 3pid (`'email'`, `'msisdn'`) required by the Synapse server for registering -- variables prefixed with `matrix_nginx_proxy_proxy_matrix_3pid_registration_` (e.g. `matrix_nginx_proxy_proxy_matrix_3pid_registration_enabled`) - to configure the integrated nginx webserver to send registration requests to mxisd (instead of Synapse), so it can apply its additional functionality +- variables prefixed with `matrix_nginx_proxy_proxy_matrix_3pid_registration_` (e.g. `matrix_nginx_proxy_proxy_matrix_3pid_registration_enabled`) - to configure the integrated nginx webserver to send registration requests to mxisd (instead of Synapse), so it can apply its additional functionality + +- `matrix_mxisd_configuration_extension_yaml` - to configure mxisd as required. See the [Registration feature's docs](https://github.com/kamax-matrix/mxisd/blob/master/docs/features/registration.md) for inspiration. Also see the [Additional features](#additional-features) section below to learn more about how to use `matrix_mxisd_configuration_extension_yaml`. -- `matrix_mxisd_configuration_extension_yaml` - to configure mxisd as required. See the [Registration feature's docs](https://github.com/kamax-matrix/mxisd/blob/master/docs/features/registration.md) for inspiration. Also see the [Additional features](#additional-features) section below to learn more about how to use `matrix_mxisd_configuration_extension_yaml`. ## Additional features @@ -46,6 +50,7 @@ To use a more custom configuration, you can define a `matrix_mxisd_configuration and put your configuration in it. To learn more about how to do this, refer to the information about `matrix_mxisd_configuration_extension_yaml` in the [default variables file](../roles/matrix-mxisd/defaults/main.yml) of the mxisd component. + ## Troubleshooting If email address validation emails sent by mxisd are not reaching you, you should look into [Adjusting email-sending settings](configuring-playbook-email.md). @@ -56,4 +61,4 @@ Example configuration (`inventory/host_vars/matrix.DOMAIN/vars.yml`): ```yaml matrix_mxisd_verbose_logging: true -``` +``` \ No newline at end of file diff --git a/docs/maintenance-and-troubleshooting.md b/docs/maintenance-and-troubleshooting.md index ef3a10de..5dd1ee3f 100644 --- a/docs/maintenance-and-troubleshooting.md +++ b/docs/maintenance-and-troubleshooting.md @@ -3,7 +3,6 @@ ## How to see the current status of your services You can check the status of your services by using `systemctl status`. Example: - ``` sudo systemctl status matrix-nginx-proxy @@ -13,11 +12,11 @@ sudo systemctl status matrix-nginx-proxy ``` You can see the logs by using journalctl. Example: - ``` sudo journalctl -fu matrix-synapse ``` + ## Increasing Synapse logging Because the [Synapse](https://github.com/matrix-org/synapse) Matrix server is originally very chatty when it comes to logging, we intentionally reduce its [logging level](https://docs.python.org/3/library/logging.html#logging-levels) from `INFO` to `WARNING`. @@ -34,10 +33,11 @@ matrix_synapse_root_log_level: "INFO" Re-run the playbook after making these configuration changes. + ## Postgres See the dedicated [PostgreSQL Maintenance](maintenance-postgres.md) documentation page. ## Mxisd -See the dedicated [Adjusting mxisd Identity Server configuration](configuring-playbook-mxisd.md) documentation page +See the dedicated [Adjusting mxisd Identity Server configuration](configuring-playbook-mxisd.md) documentation page. \ No newline at end of file