mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-02-11 01:28:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4025 from luixxiul/fix

Browse Source 
Update docs for Synapse
This commit is contained in:
Slavi Pantaleev 2025-02-04 08:34:31 +02:00 committed by GitHub
commit 2473581b3a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 19 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/configuring-playbook-synapse.md
View File

@ -2,6 +2,8 @@
By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, so that it works for the general case. If that's okay, you can skip this document.
💡 See this page for details about maintaining Synapse: [Synapse maintenance](maintenance-synapse.md)
## Adjusting the playbook configuration
### Load balancing with workers
@ -173,3 +175,18 @@ This playbook allows you to enable Synapse metrics, which can provide insight in
To enable Synapse runtime metrics see: [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md)
To enable Synapse usage metrics, see: [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md)
## Troubleshooting
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-synapse`.
### Increase logging verbosity
Because Synapse 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`.
If you'd like to debug an issue or [report a Synapse bug](https://github.com/element-hq/synapse/issues/new/choose) to the developers, it'd be better if you temporarily increase the logging verbosity to `INFO`. To do so, add the following configuration to your `vars.yml` file and re-run the playbook:
```yaml
matrix_synapse_log_level: "INFO"
matrix_synapse_storage_sql_log_level: "INFO"
matrix_synapse_root_log_level: "INFO"

16
docs/maintenance-and-troubleshooting.md
View File

@ -22,22 +22,6 @@ To view systemd-journald logs using [journalctl](https://man.archlinux.org/man/j
sudo journalctl -fu matrix-synapse
```
## Increase logging verbosity
Because the [Synapse](https://github.com/element-hq/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`.
If you'd like to debug an issue or [report a Synapse bug](https://github.com/element-hq/synapse/issues/new/choose) to the developers, it'd be better if you temporarily increasing the logging level to `INFO`.
Example configuration (`inventory/host_vars/matrix.example.com/vars.yml`):
```yaml
matrix_synapse_log_level: "INFO"
matrix_synapse_storage_sql_log_level: "INFO"
matrix_synapse_root_log_level: "INFO"
```
Re-run the playbook after making these configuration changes.
## How to check if services work
The playbook can perform a check to ensure that you've configured things correctly and that services are running.

2
docs/maintenance-synapse.md
View File

@ -12,6 +12,8 @@ Table of contents:
- [Make Synapse faster](#make-synapse-faster)
💡 See this page for details about configuring Synapse: [Configuring Synapse](configuring-playbook-synapse.md)
## Purging old data with the Purge History API
You can use the **[Purge History API](https://github.com/element-hq/synapse/blob/master/docs/admin_api/purge_history_api.md)** to delete old messages on a per-room basis. **This is destructive** (especially for non-federated rooms), because it means **people will no longer have access to history past a certain point**.