diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c3133da0..aeb956290 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3344,7 +3344,7 @@ Due to changes related to certificate file requirements that will affect us at S **What you need to do now** is make use of this transitional Synapse v0.99 release to **prepare your federation settings for the future**. You have 2 choices to prepare yourself for compatibility with the future Synapse v1.0: -- (recommended) set up [Server Delegation via a well-known file](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file), unless you are affected by the [Downsides of well-known-based Server Delegation](docs/howto-server-delegation.md#downsides-of-well-known-based-server-delegation). If you had previously set up the well-known `client` file, depending on how you've done it, it may be that there is nothing new required of you (besides [upgrading](docs/maintenance-upgrading-services.md)). After upgrading, you can [run a self-check](docs/maintenance-checking-services.md), which will tell you if you need to do anything extra with regard to setting up [Server Delegation via a well-known file](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file). After some time, when most people have upgraded to Synapse v0.99 and older releases have disappeared, be prepared to drop your `_matrix._tcp` SRV record. +- (recommended) set up [Server Delegation via a well-known file](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file), unless you are affected by the [Downsides of well-known-based Server Delegation](docs/howto-server-delegation.md#downsides-of-well-known-based-server-delegation). If you had previously set up the well-known `client` file, depending on how you've done it, it may be that there is nothing new required of you (besides [upgrading](docs/maintenance-upgrading-services.md)). After upgrading, you can [run a self-check](docs/maintenance-and-troubleshooting.md#how-to-check-if-services-work), which will tell you if you need to do anything extra with regard to setting up [Server Delegation via a well-known file](docs/howto-server-delegation.md#server-delegation-via-a-well-known-file). After some time, when most people have upgraded to Synapse v0.99 and older releases have disappeared, be prepared to drop your `_matrix._tcp` SRV record. - (more advanced) if the [Downsides of well-known-based Server Delegation](docs/howto-server-delegation.md#downsides-of-well-known-based-server-delegation) are not to your liking, **as an alternative**, you can set up [Server Delegation via a DNS SRV record](docs/howto-server-delegation.md#server-delegation-via-a-dns-srv-record-advanced). In such a case, you get to keep using your existing `_matrix._tcp` DNS SRV record forever and need to NOT set up a `/.well-known/matrix/server` file. Don't forget that you need to do certificate changes though. Follow the guide at [Server Delegation via a DNS SRV record](docs/howto-server-delegation.md#server-delegation-via-a-dns-srv-record-advanced). @@ -3661,7 +3661,7 @@ From now on, Riot's configuration setting `disable_guests` would be set to `true ## Self-check maintenance command -The playbook can now [check if services are configured correctly](docs/maintenance-checking-services.md). +The playbook can now [check if services are configured correctly](docs/maintenance-and-troubleshooting.md#how-to-check-if-services-work). # 2018-10-05 diff --git a/docs/README.md b/docs/README.md index 600a4c557..34a660c7b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -51,8 +51,6 @@ If your server and services experience issues, feel free to come to [our support -- [Checking if services work](maintenance-checking-services.md) - - [Maintenance and Troubleshooting](maintenance-and-troubleshooting.md) - [PostgreSQL maintenance](maintenance-postgres.md) diff --git a/docs/configuring-playbook-federation.md b/docs/configuring-playbook-federation.md index 87e573830..e87d10e79 100644 --- a/docs/configuring-playbook-federation.md +++ b/docs/configuring-playbook-federation.md @@ -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 diff --git a/docs/configuring-well-known.md b/docs/configuring-well-known.md index e7bbc9562..58bd1615b 100644 --- a/docs/configuring-well-known.md +++ b/docs/configuring-well-known.md @@ -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). diff --git a/docs/installing.md b/docs/installing.md index 10bbd32bc..860e8d9bf 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -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) diff --git a/docs/maintenance-and-troubleshooting.md b/docs/maintenance-and-troubleshooting.md index 0ab46f900..41704dfe4 100644 --- a/docs/maintenance-and-troubleshooting.md +++ b/docs/maintenance-and-troubleshooting.md @@ -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. diff --git a/docs/maintenance-checking-services.md b/docs/maintenance-checking-services.md deleted file mode 100644 index b2d90554c..000000000 --- a/docs/maintenance-checking-services.md +++ /dev/null @@ -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. diff --git a/docs/maintenance-migrating.md b/docs/maintenance-migrating.md index e2c0a7efa..2aa2e5a86 100644 --- a/docs/maintenance-migrating.md +++ b/docs/maintenance-migrating.md @@ -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.