Skip to content

Commit 0d2bb0b

Browse files
author
Suguru Hirahara
committed
Update docs for maintenance: add the description about providers blocking the federation port
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
1 parent 057bd16 commit 0d2bb0b

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/maintenance-and-troubleshooting.md

+8
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,14 @@ If it's all green, everything is probably running correctly.
107107

108108
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.
109109

110+
#### In case of Matrix Federation API port not being able to be reached after migration
111+
112+
Please note that some server providers block TCP/UDP ports which are not quite often used based on their judgment (in order to improve security, to mitigate the risk of abuse, etc). It can cause that your Matrix instance on a new server cannot be reached via Matrix Federation API port (`8448`) after migration, resulting in the error about federation when running self-check test.
113+
114+
In this case, make sure that your server provider does not block the port by default. As this playbook makes Docker configure the server's internal firewall for you as described [here](prerequisites.md), you mostly do not have to edit the firewall rules by yourself, unless your server is running behind another firewall.
115+
116+
If the provider was indeed found to disallow the port, you need to allow it explicitly on the server configuration for managing ports (control panel, etc), as it is not able for this playbook to update the upstream configuration. Please consult the documentation of the provider for details about it.
117+
110118
### How to debug or force SSL certificate renewal
111119

112120
SSL certificates are managed automatically by the [Traefik](https://doc.traefik.io/traefik/) reverse-proxy server.

docs/maintenance-migrating.md

+2
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,5 @@ The shortcut command with `just` program is also available: `just run-tags insta
7878
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)
7979

8080
Having make sure that both services and federation work as expected, you can safely shutdown the old server.
81+
82+
**Note**: if Matrix Federation API port cannot be reached after migration, it might be due to the server provider not allowing the port by default. Take a look at [this section](maintenance-and-troubleshooting.md#in-case-of-matrix-federation-api-port-not-being-able-to-be-reached-after-migration) to troubleshoot.

0 commit comments

Comments
 (0)