- Create sections for the instruction about opening Matrix Federation port - Remove unmaintained components which this project does not recommend to install from examples about opening the port on docs/prerequisites.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3904/head
| @@ -2,7 +2,7 @@ | |||||
| **Notes**: | **Notes**: | ||||
| - Dimension is **[officially unmaintained](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2806#issuecomment-1673559299)**. We recommend not bothering with installing it. | - Dimension is **[officially unmaintained](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2806#issuecomment-1673559299)**. We recommend not bothering with installing it. | ||||
| - This playbook now supports running Dimension in both a federated and [unfederated](https://github.com/turt2live/matrix-dimension/blob/master/docs/unfederated.md) environments. This is handled automatically based on the value of `matrix_homeserver_federation_enabled`. Enabling Dimension, means that the `openid` API endpoints will be exposed on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. It's something to be aware of, especially in terms of firewall whitelisting (make sure port `8448` is accessible). | |||||
| - This playbook now supports running Dimension in both a federated and [unfederated](https://github.com/turt2live/matrix-dimension/blob/master/docs/unfederated.md) environments. This is handled automatically based on the value of `matrix_homeserver_federation_enabled`. | |||||
| The playbook can install and configure the [Dimension](https://dimension.t2bot.io) integration manager for you. | The playbook can install and configure the [Dimension](https://dimension.t2bot.io) integration manager for you. | ||||
| @@ -10,6 +10,10 @@ See the project's [documentation](https://github.com/turt2live/matrix-dimension/ | |||||
| ## Prerequisites | ## Prerequisites | ||||
| ### Open Matrix Federation port | |||||
| Dimension exposes the `openid` API endpoints on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. If you enable the component, make sure that port is accessible. | |||||
| ### Install Matrix services | ### Install Matrix services | ||||
| Dimension can only be installed after Matrix services are installed and running. If you're just installing Matrix services for the first time, please continue with the [Configuration](configuring-playbook.md) / [Installation](installing.md) and come back here later. | Dimension can only be installed after Matrix services are installed and running. If you're just installing Matrix services for the first time, please continue with the [Configuration](configuring-playbook.md) / [Installation](installing.md) and come back here later. | ||||
| @@ -8,7 +8,11 @@ ma1sd is used for 3PIDs (3rd party identifiers like E-mail and phone numbers) an | |||||
| See the project's [documentation](https://github.com/ma1uta/ma1sd/blob/master/README.md) to learn what it does and why it might be useful to you. | See the project's [documentation](https://github.com/ma1uta/ma1sd/blob/master/README.md) to learn what it does and why it might be useful to you. | ||||
| **Note**: enabling ma1sd, means that the `openid` API endpoints will be exposed on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. It's something to be aware of, especially in terms of firewall whitelisting (make sure port `8448` is accessible). | |||||
| ## Prerequisites | |||||
| ### Open Matrix Federation port | |||||
| ma1sd exposes the `openid` API endpoints on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. If you enable the component, make sure that port is accessible. | |||||
| ## Adjusting DNS records | ## Adjusting DNS records | ||||
| @@ -4,11 +4,7 @@ The playbook can install and configure [Matrix User Verification Service](https: | |||||
| See the project's [documentation](https://github.com/matrix-org/matrix-user-verification-service/blob/master/README.md) to learn what it does and why it might be useful to you. | See the project's [documentation](https://github.com/matrix-org/matrix-user-verification-service/blob/master/README.md) to learn what it does and why it might be useful to you. | ||||
| Currently, the main purpose of this role is to allow Jitsi to authenticate Matrix users and check if they are authorized to join a conference. | |||||
| **Note**: enabling UVS, means that the `openid` API endpoints will be exposed on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. | |||||
| If the Jitsi server is also configured by this playbook, all plugging of variables and secrets is handled in `group_vars/matrix_servers`. | |||||
| Currently, the main purpose of this role is to allow Jitsi to authenticate Matrix users and check if they are authorized to join a conference. If the Jitsi server is also configured by this playbook, all plugging of variables and secrets is handled in `group_vars/matrix_servers`. | |||||
| __Some general concepts of UVS may be helpful to understand the rest, so here they are:__ | __Some general concepts of UVS may be helpful to understand the rest, so here they are:__ | ||||
| @@ -23,6 +19,10 @@ Verifying RoomMembership and PowerLevel is done against `matrix_user_verificatio | |||||
| ## Prerequisites | ## Prerequisites | ||||
| ### Open Matrix Federation port | |||||
| UVS exposes the `openid` API endpoints on the Matrix Federation port (usually `8448`), even if [federation](configuring-playbook-federation.md) is disabled. If you enable the component, make sure that port is accessible. | |||||
| ### Install Matrix services | ### Install Matrix services | ||||
| UVS can only be installed after Matrix services are installed and running. If you're just installing Matrix services for the first time, please continue with the [Configuration](configuring-playbook.md) / [Installation](installing.md) and come back here later. | UVS can only be installed after Matrix services are installed and running. If you're just installing Matrix services for the first time, please continue with the [Configuration](configuring-playbook.md) / [Installation](installing.md) and come back here later. | ||||
| @@ -52,7 +52,7 @@ We will be using `example.com` as the domain in the following instruction. Pleas | |||||
| - `3478/udp`: TURN over UDP (used by Coturn) | - `3478/udp`: TURN over UDP (used by Coturn) | ||||
| - `5349/tcp`: TURN over TCP (used by Coturn) | - `5349/tcp`: TURN over TCP (used by Coturn) | ||||
| - `5349/udp`: TURN over UDP (used by Coturn) | - `5349/udp`: TURN over UDP (used by Coturn) | ||||
| - `8448/tcp` and `8448/udp`: Matrix Federation API HTTPS webserver. In some cases, this **may necessary even with federation disabled**. Integration Servers (like Dimension) and Identity Servers (like ma1sd) may need to access `openid` APIs on the federation port. | |||||
| - `8448/tcp` and `8448/udp`: Matrix Federation API HTTPS webserver. Some components like [Matrix User Verification Service](configuring-playbook-user-verification-service.md#open-matrix-federation-port) require this port to be opened **even with federation disabled**. | |||||
| - the range `49152-49172/udp`: TURN over UDP | - the range `49152-49172/udp`: TURN over UDP | ||||
| - potentially some other ports, depending on the additional (non-default) services that you enable in the **configuring the playbook** step (later on). Consult each service's documentation page in `docs/` for that. | - potentially some other ports, depending on the additional (non-default) services that you enable in the **configuring the playbook** step (later on). Consult each service's documentation page in `docs/` for that. | ||||