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

Update maintenance-and-troubleshooting.md: create sections "Maintenance" and "Troubleshooting"

Browse Source 
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara 2025-02-01 16:21:21 +09:00
parent ecdf370cb7
commit bd794e8c2c
No known key found for this signature in database
GPG Key ID: E4F9743DAB4B7B75
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,6 +1,24 @@
# Maintenance and Troubleshooting # Maintenance and Troubleshooting
## How to see the current status of your services ## Maintenance
### Remove unused Docker data
You can free some disk space from Docker by removing its unused data. See [docker system prune](https://docs.docker.com/engine/reference/commandline/system_prune/) for more information.
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=run-docker-prune
```
The shortcut command with `just` program is also available: `just run-tags run-docker-prune`
### Postgres
See the dedicated [PostgreSQL Maintenance](maintenance-postgres.md) documentation page.
## Troubleshooting
### How to see the current status of your services
You can check the status of your services by using `systemctl status`. Example: You can check the status of your services by using `systemctl status`. Example:
@ -12,7 +30,7 @@ sudo systemctl status matrix-synapse
Active: active (running) since Sun 2024-01-14 09:13:06 UTC; 1h 31min ago Active: active (running) since Sun 2024-01-14 09:13:06 UTC; 1h 31min ago
``` ```
## How to see the logs ### How to see the logs
Docker containers that the playbook configures are supervised by [systemd](https://wiki.archlinux.org/title/Systemd) and their logs are configured to go to [systemd-journald](https://wiki.archlinux.org/title/Systemd/Journal). Docker containers that the playbook configures are supervised by [systemd](https://wiki.archlinux.org/title/Systemd) and their logs are configured to go to [systemd-journald](https://wiki.archlinux.org/title/Systemd/Journal).
@ -26,7 +44,7 @@ Available service names can be seen by doing `ls /etc/systemd/system/matrix*.ser
We just simply delegate logging to journald and it takes care of persistence and expiring old data. We just simply delegate logging to journald and it takes care of persistence and expiring old data.
### Enable systemd/journald logs persistence #### Enable systemd/journald logs persistence
On some distros, the journald logs are just in-memory and not persisted to disk. On some distros, the journald logs are just in-memory and not persisted to disk.
@ -43,7 +61,7 @@ RateLimitBurst=0
Storage=persistent Storage=persistent
``` ```
## How to check if services work ### 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. The playbook can perform a check to ensure that you've configured things correctly and that services are running.
@ -58,17 +76,3 @@ The shortcut command with `just` program is also available: `just run-tags self-
If it's all green, everything is probably running correctly. If it's all green, everything is probably running correctly.
Besides this self-check, you can also check whether your server federates with the Matrix network by using the [Federation Tester](https://federationtester.matrix.org/) against your base domain (`example.com`), not the `matrix.example.com` subdomain. Besides this self-check, you can also check whether your server federates with the Matrix network by using the [Federation Tester](https://federationtester.matrix.org/) against your base domain (`example.com`), not the `matrix.example.com` subdomain.
## Remove unused Docker data
You can free some disk space from Docker by removing its unused data. See [docker system prune](https://docs.docker.com/engine/reference/commandline/system_prune/) for more information.
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=run-docker-prune
```
The shortcut command with `just` program is also available: `just run-tags run-docker-prune`
## Postgres
See the dedicated [PostgreSQL Maintenance](maintenance-postgres.md) documentation page.