Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3755/head
| @@ -2427,7 +2427,7 @@ To learn more, follow our [Dynamic DNS docs page](docs/configuring-playbook-dyna | |||||
| Until now, we used to serve a static page coming from Synapse at `https://matrix.example.com/`. This page was not very useful to anyone. | Until now, we used to serve a static page coming from Synapse at `https://matrix.example.com/`. This page was not very useful to anyone. | ||||
| Since `matrix.example.com` may be accessed by regular users in certain conditions, it's probably better to redirect them to a better place (e.g. to [Element Web](docs/configuring-playbook-client-element.md)). | |||||
| Since `matrix.example.com` may be accessed by regular users in certain conditions, it's probably better to redirect them to a better place (e.g. to [Element Web](docs/configuring-playbook-client-element-web.md)). | |||||
| If Element Web is installed (`matrix_client_element_enabled: true`, which it is by default), we now redirect people to it, instead of showing them a Synapse static page. | If Element Web is installed (`matrix_client_element_enabled: true`, which it is by default), we now redirect people to it, instead of showing them a Synapse static page. | ||||
| @@ -53,7 +53,7 @@ Web clients for Matrix that you can host on your own domains. | |||||
| | Name | Default? | Description | Documentation | | | Name | Default? | Description | Documentation | | ||||
| | ---- | -------- | ----------- | ------------- | | | ---- | -------- | ----------- | ------------- | | ||||
| | [Element Web](https://github.com/element-hq/element-web) | ✅ | Default Matrix web client, configured to connect to your own Synapse server | [Link](docs/configuring-playbook-client-element.md) | | |||||
| | [Element Web](https://github.com/element-hq/element-web) | ✅ | Default Matrix web client, configured to connect to your own Synapse server | [Link](docs/configuring-playbook-client-element-web.md) | | |||||
| | [Hydrogen](https://github.com/element-hq/hydrogen-web) | ❌ | Lightweight Matrix client with legacy and mobile browser support | [Link](docs/configuring-playbook-client-hydrogen.md) | | | [Hydrogen](https://github.com/element-hq/hydrogen-web) | ❌ | Lightweight Matrix client with legacy and mobile browser support | [Link](docs/configuring-playbook-client-hydrogen.md) | | ||||
| | [Cinny](https://github.com/ajbura/cinny) | ❌ | Simple, elegant and secure web client | [Link](docs/configuring-playbook-client-cinny.md) | | | [Cinny](https://github.com/ajbura/cinny) | ❌ | Simple, elegant and secure web client | [Link](docs/configuring-playbook-client-cinny.md) | | ||||
| | [SchildiChat Web](https://schildi.chat/) | ❌ | Based on Element Web, with a more traditional instant messaging experience | [Link](docs/configuring-playbook-client-schildichat-web.md) | | | [SchildiChat Web](https://schildi.chat/) | ❌ | Based on Element Web, with a more traditional instant messaging experience | [Link](docs/configuring-playbook-client-schildichat-web.md) | | ||||
| @@ -1,6 +1,6 @@ | |||||
| # Setting up the Jitsi video-conferencing platform (optional) | # Setting up the Jitsi video-conferencing platform (optional) | ||||
| The playbook can install the [Jitsi](https://jitsi.org/) video-conferencing platform and integrate it with Element clients ([Element Web](configuring-playbook-client-element.md)/Desktop, Android and iOS). | |||||
| The playbook can install the [Jitsi](https://jitsi.org/) video-conferencing platform and integrate it with Element clients ([Element Web](configuring-playbook-client-element-web.md)/Desktop, Android and iOS). | |||||
| Jitsi installation is **not enabled by default**, because it's not a core component of Matrix services. | Jitsi installation is **not enabled by default**, because it's not a core component of Matrix services. | ||||
| @@ -76,7 +76,7 @@ This section details what you can expect when switching to the Matrix Authentica | |||||
| - ✅ Your **existing login sessions will continue to work** (you won't get logged out). Migration will require a bit of manual work and minutes of downtime, but it's not too bad. | - ✅ Your **existing login sessions will continue to work** (you won't get logged out). Migration will require a bit of manual work and minutes of downtime, but it's not too bad. | ||||
| - ✅ Various clients ([Cinny](./configuring-playbook-client-cinny.md), [Element Web](./configuring-playbook-client-element.md), Element X, FluffyChat) will be able to use the **new SSO-based login flow** provided by Matrix Authentication Service | |||||
| - ✅ Various clients ([Cinny](./configuring-playbook-client-cinny.md), [Element Web](./configuring-playbook-client-element-web.md), Element X, FluffyChat) will be able to use the **new SSO-based login flow** provided by Matrix Authentication Service | |||||
| - ✅ The **old login flow** (called `m.login.password`) **will still continue to work**, so clients (old Element Web, etc.) and bridges/bots that don't support the new OIDC-based login flow will still work. Going through the old login flow does not require users to have a verified email address, as [is the case](https://github.com/element-hq/matrix-authentication-service/issues/1505) for the new SSO-based login flow. | - ✅ The **old login flow** (called `m.login.password`) **will still continue to work**, so clients (old Element Web, etc.) and bridges/bots that don't support the new OIDC-based login flow will still work. Going through the old login flow does not require users to have a verified email address, as [is the case](https://github.com/element-hq/matrix-authentication-service/issues/1505) for the new SSO-based login flow. | ||||
| @@ -4,7 +4,7 @@ By default, this playbook **used to install** the [Riot-web](https://github.com/ | |||||
| Riot has since been [renamed to Element](https://element.io/blog/welcome-to-element/). | Riot has since been [renamed to Element](https://element.io/blog/welcome-to-element/). | ||||
| - to learn more about Element Web and its configuration, see our dedicated [Configuring Element Web](configuring-playbook-client-element.md) documentation page | |||||
| - to learn more about Element Web and its configuration, see our dedicated [Configuring Element Web](configuring-playbook-client-element-web.md) documentation page | |||||
| - to learn how to migrate from Riot to Element Web, see [Migrating to Element Web](#migrating-to-element-web) below | - to learn how to migrate from Riot to Element Web, see [Migrating to Element Web](#migrating-to-element-web) below | ||||
| @@ -70,7 +70,7 @@ When you're done with all the configuration you'd like to do, continue with [Ins | |||||
| Web clients for Matrix that you can host on your own domains. | Web clients for Matrix that you can host on your own domains. | ||||
| - [Configuring Element Web](configuring-playbook-client-element.md), if you're going with the default/recommended client | |||||
| - [Configuring Element Web](configuring-playbook-client-element-web.md), if you're going with the default/recommended client | |||||
| - [Setting up Hydrogen](configuring-playbook-client-hydrogen.md), if you've enabled [Hydrogen](https://github.com/element-hq/hydrogen-web), a lightweight Matrix client with legacy and mobile browser support | - [Setting up Hydrogen](configuring-playbook-client-hydrogen.md), if you've enabled [Hydrogen](https://github.com/element-hq/hydrogen-web), a lightweight Matrix client with legacy and mobile browser support | ||||
| @@ -19,7 +19,7 @@ Web clients for Matrix that you can host on your own domains. | |||||
| | Service | Container image | Default? | Description | | | Service | Container image | Default? | Description | | ||||
| | ------- | --------------- | -------- | ----------- | | | ------- | --------------- | -------- | ----------- | | ||||
| | [Element Web](configuring-playbook-client-element.md) | [vectorim/element-web](https://hub.docker.com/r/vectorim/element-web/) | ✓ | Default Matrix web client, configured to connect to your own Synapse server | | |||||
| | [Element Web](configuring-playbook-client-element-web.md) | [vectorim/element-web](https://hub.docker.com/r/vectorim/element-web/) | ✓ | Default Matrix web client, configured to connect to your own Synapse server | | |||||
| | [Hydrogen](configuring-playbook-client-hydrogen.md) | [element-hq/hydrogen-web](https://ghcr.io/element-hq/hydrogen-web) | x | Lightweight Matrix client with legacy and mobile browser support | | | [Hydrogen](configuring-playbook-client-hydrogen.md) | [element-hq/hydrogen-web](https://ghcr.io/element-hq/hydrogen-web) | x | Lightweight Matrix client with legacy and mobile browser support | | ||||
| | [Cinny](configuring-playbook-client-cinny.md) | [ajbura/cinny](https://hub.docker.com/r/ajbura/cinny) | x | Simple, elegant and secure web client | | | [Cinny](configuring-playbook-client-cinny.md) | [ajbura/cinny](https://hub.docker.com/r/ajbura/cinny) | x | Simple, elegant and secure web client | | ||||
| | [SchildiChat Web](configuring-playbook-client-schildichat-web.md) | [etke.cc/schildichat-web](https://ghcr.io/etkecc/schildichat-web) | x | Based on Element Web, with a more traditional instant messaging experience | | | [SchildiChat Web](configuring-playbook-client-schildichat-web.md) | [etke.cc/schildichat-web](https://ghcr.io/etkecc/schildichat-web) | x | Based on Element Web, with a more traditional instant messaging experience | | ||||
| @@ -16,7 +16,7 @@ Table of contents: | |||||
| **Note**: in the commands below, `<your-username>` is just a plain username (like `john`), not your full `@<username>:example.com` identifier. | **Note**: in the commands below, `<your-username>` is just a plain username (like `john`), not your full `@<username>:example.com` identifier. | ||||
| After registering a user (using one of the methods below), **you can log in with that user** via the [Element Web](configuring-playbook-client-element.md) service that this playbook has installed for you at a URL like this: `https://element.example.com/`. | |||||
| After registering a user (using one of the methods below), **you can log in with that user** via the [Element Web](configuring-playbook-client-element-web.md) service that this playbook has installed for you at a URL like this: `https://element.example.com/`. | |||||
| ### Registering users via the Ansible playbook | ### Registering users via the Ansible playbook | ||||
| @@ -14,4 +14,4 @@ Copy the [matrix.conf](matrix.conf) file to your nginx server's filesystem, modi | |||||
| This configuration **disables SSL certificate retrieval**, so you will **need to obtain SSL certificates manually** (e.g. by using [certbot](https://certbot.eff.org/)) and set the appropriate path in `matrix.conf`. In the example nginx configuration, a single certificate is used for all subdomains (`matrix.example.com`, `element.example.com`, etc.). For your setup, may wish to change this and use separate `server` blocks and separate certificate files for each host. | This configuration **disables SSL certificate retrieval**, so you will **need to obtain SSL certificates manually** (e.g. by using [certbot](https://certbot.eff.org/)) and set the appropriate path in `matrix.conf`. In the example nginx configuration, a single certificate is used for all subdomains (`matrix.example.com`, `element.example.com`, etc.). For your setup, may wish to change this and use separate `server` blocks and separate certificate files for each host. | ||||
| Also note that your copy of the `matrix.conf` file has to be adapted to whatever services you are using. For example, remove `element.example.com` from the `server_name` list if you don't use [Element Web](../../../docs/configuring-playbook-client-element.md) client or add `dimension.example.com` to it if you do use the [Dimension](../../../docs/configuring-playbook-dimension.md) integration manager. | |||||
| Also note that your copy of the `matrix.conf` file has to be adapted to whatever services you are using. For example, remove `element.example.com` from the `server_name` list if you don't use [Element Web](../../../docs/configuring-playbook-client-element-web.md) client or add `dimension.example.com` to it if you do use the [Dimension](../../../docs/configuring-playbook-dimension.md) integration manager. | |||||