Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md

IMHO it seems to be sensible to concentrate details about maintenance at one documentation page for the sake of maintainability, rather than maintaining pages with a single short section.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara
2025-01-31 02:56:46 +09:00
parent aa70e61dd8
commit 42b19566c2
8 changed files with 22 additions and 23 deletions

View File

@ -51,8 +51,6 @@ If your server and services experience issues, feel free to come to [our support
<!-- NOTE: sort list items alphabetically -->
- [Checking if services work](maintenance-checking-services.md)
- [Maintenance and Troubleshooting](maintenance-and-troubleshooting.md)
- [PostgreSQL maintenance](maintenance-postgres.md)

View File

@ -2,7 +2,7 @@
By default, your server federates with the whole Matrix network. That is, people on your server can communicate with people on any other Matrix server.
**Note**: in the sample `vars.yml` ([`examples/vars.yml`](../examples/vars.yml)), we recommend to use a short user ID like `@alice:example.com` instead of `@alice:matrix.example.com` and set up [server delegation](howto-server-delegation.md) / redirection. Without a proper configuration, your server will effectively not be part of the Matrix network. If you find your server is not federated, make sure to [check whether services work](maintenance-checking-services.md) and your server is properly delegated.
**Note**: in the sample `vars.yml` ([`examples/vars.yml`](../examples/vars.yml)), we recommend to use a short user ID like `@alice:example.com` instead of `@alice:matrix.example.com` and set up [server delegation](howto-server-delegation.md) / redirection. Without a proper configuration, your server will effectively not be part of the Matrix network. If you find your server is not federated, make sure to [check whether services work](maintenance-and-troubleshooting.md#how-to-check-if-services-work) and your server is properly delegated.
## Federating only with select servers

View File

@ -185,4 +185,4 @@ No matter which method you've used to set up the well-known files, if you've don
- `https://example.com/.well-known/matrix/client`
- `https://example.com/.well-known/matrix/support`
You can also check if everything is configured correctly, by [checking if services work](maintenance-checking-services.md).
You can also check if everything is configured correctly, by [checking if services work](maintenance-and-troubleshooting.md#how-to-check-if-services-work).

View File

@ -124,7 +124,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=install-matrix-static-files
After finilizing the installation, you can:
- [check if services work](maintenance-checking-services.md)
- [check if services work](maintenance-and-troubleshooting.md#how-to-check-if-services-work)
- or [set up additional services](configuring-playbook.md#other-configuration-options) (bridges to other chat networks, bots, etc.)
- or learn how to [upgrade services when new versions are released](maintenance-upgrading-services.md)
- or learn how to [maintain your server](faq.md#maintenance)

View File

@ -38,6 +38,22 @@ 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.
To perform the check, run:
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=self-check
```
The shortcut command with `just` program is also available: `just run-tags self-check`
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.
## Remove unused Docker data
You can free some disk space from Docker, see [docker system prune](https://docs.docker.com/engine/reference/commandline/system_prune/) for more information.

View File

@ -1,15 +0,0 @@
# Checking if services work
The playbook can perform a check to ensure that you've configured things correctly and that services are running.
To perform the check, run:
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=self-check
```
The shortcut command with `just` program is also available: `just run-tags self-check`
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.

View File

@ -66,6 +66,6 @@ The shortcut command with `just` program is also available: `just run-tags insta
### Check if services work
After starting the services, you probably might want to ensure that you've migrated things correctly and that services are running. For instructions, see: [check if services work](maintenance-checking-services.md)
After starting the services, you probably might want to ensure that you've migrated things correctly and that services are running. For instructions, see: [check if services work](maintenance-and-troubleshooting.md#how-to-check-if-services-work)
Having make sure that both services and federation work as expected, you can safely shutdown the old server.