mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-11-06 02:37:31 +01:00
Fix capitalization: matrix → Matrix
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara
parent
08a569b0e6
commit
55fcaac1f1
@ -1968,7 +1968,7 @@ If you need to downgrade to the previous version, changing `matrix_sygnal_versio
|
||||
|
||||
## Hydrogen support
|
||||
|
||||
Thanks to [Aaron Raimist](https://github.com/aaronraimist), the playbook now supports [Hydrogen](https://github.com/vector-im/hydrogen-web) - a new lightweight matrix client with legacy and mobile browser support.
|
||||
Thanks to [Aaron Raimist](https://github.com/aaronraimist), the playbook now supports [Hydrogen](https://github.com/vector-im/hydrogen-web) - a new lightweight Matrix client with legacy and mobile browser support.
|
||||
|
||||
By default, we still install Element, as Hydrogen is still not fully-featured. Still, people who'd like to try Hydrogen out can now install it via the playbook.
|
||||
|
||||
|
||||
22
README.md
22
README.md
@ -31,7 +31,7 @@ You can always re-run the playbook later to add or remove components.
|
||||
|
||||
### Homeserver
|
||||
|
||||
The homeserver is the backbone of your matrix system. Choose one from the following list.
|
||||
The homeserver is the backbone of your Matrix system. Choose one from the following list.
|
||||
|
||||
| Name | Default? | Description | Documentation |
|
||||
| ---- | -------- | ----------- | ------------- |
|
||||
@ -41,12 +41,12 @@ The homeserver is the backbone of your matrix system. Choose one from the follow
|
||||
|
||||
### Clients
|
||||
|
||||
Web clients for matrix that you can host on your own domains.
|
||||
Web clients for Matrix that you can host on your own domains.
|
||||
|
||||
| Name | Default? | Description | Documentation |
|
||||
| ---- | -------- | ----------- | ------------- |
|
||||
| [Element](https://app.element.io/) | ✓ | Web UI, which is configured to connect to your own Synapse server by default | [Link](docs/configuring-playbook-client-element.md) |
|
||||
| [Hydrogen](https://github.com/element-hq/hydrogen-web) | x | Lightweight matrix client with legacy and mobile browser support | [Link](docs/configuring-playbook-client-hydrogen.md) |
|
||||
| [Hydrogen](https://github.com/element-hq/hydrogen-web) | x | Lightweight Matrix client with legacy and mobile browser support | [Link](docs/configuring-playbook-client-hydrogen.md) |
|
||||
| [Cinny](https://github.com/ajbura/cinny) | x | Simple, elegant and secure web client | [Link](docs/configuring-playbook-client-cinny.md) |
|
||||
| [SchildiChat](https://schildi.chat/) | x | Based on Element, with a more traditional instant messaging experience | [Link](docs/configuring-playbook-client-schildichat.md) |
|
||||
|
||||
@ -64,7 +64,7 @@ Services that run on the server to make the various parts of your installation w
|
||||
| [Let's Encrypt](https://letsencrypt.org/) | ✓ | Free SSL certificate, which secures the connection to all components | [Link](docs/configuring-playbook-ssl-certificates.md) |
|
||||
| [ma1sd](https://github.com/ma1uta/ma1sd) | x | Matrix Identity Server | [Link](docs/configuring-playbook-ma1sd.md)
|
||||
| [Exim](https://www.exim.org/) | ✓ | Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server) | [Link](docs/configuring-playbook-email.md) |
|
||||
| [Dimension](https://github.com/turt2live/matrix-dimension) | x | An open source integrations manager for matrix clients | [Link](docs/configuring-playbook-dimension.md) |
|
||||
| [Dimension](https://github.com/turt2live/matrix-dimension) | x | An open source integrations manager for Matrix clients | [Link](docs/configuring-playbook-dimension.md) |
|
||||
| [Sygnal](https://github.com/matrix-org/sygnal) | x | Push gateway | [Link](docs/configuring-playbook-sygnal.md) |
|
||||
| [ntfy](https://ntfy.sh) | x | Push notifications server | [Link](docs/configuring-playbook-ntfy.md) |
|
||||
|
||||
@ -79,7 +79,7 @@ Extend and modify how users are authenticated on your homeserver.
|
||||
|[matrix-synapse-shared-secret-auth](https://github.com/devture/matrix-synapse-shared-secret-auth) (advanced) | x | Password provider module | [Link](docs/configuring-playbook-shared-secret-auth.md) |
|
||||
| [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) (advanced) | x | LDAP Auth password provider module | [Link](docs/configuring-playbook-ldap-auth.md) |
|
||||
| [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) (advanced) | x | A proxy that handles Matrix registration requests and forwards them to LDAP. | [Link](docs/configuring-playbook-matrix-ldap-registration-proxy.md) |
|
||||
| [matrix-registration](https://github.com/ZerataX/matrix-registration) | x | A simple python application to have a token based matrix registration | [Link](docs/configuring-playbook-matrix-registration.md) |
|
||||
| [matrix-registration](https://github.com/ZerataX/matrix-registration) | x | A simple python application to have a token based Matrix registration | [Link](docs/configuring-playbook-matrix-registration.md) |
|
||||
|
||||
|
||||
### File Storage
|
||||
@ -94,7 +94,7 @@ Use alternative file storage to the default `media_store` folder.
|
||||
|
||||
### Bridges
|
||||
|
||||
Bridges can be used to connect your matrix installation with third-party communication networks.
|
||||
Bridges can be used to connect your Matrix installation with third-party communication networks.
|
||||
|
||||
| Name | Default? | Description | Documentation |
|
||||
| ---- | -------- | ----------- | ------------- |
|
||||
@ -138,16 +138,16 @@ Bots provide various additional functionality to your installation.
|
||||
| [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) | x | Bot for invitations by creating and managing registration tokens | [Link](docs/configuring-playbook-bot-matrix-registration-bot.md) |
|
||||
| [maubot](https://github.com/maubot/maubot) | x | A plugin-based Matrix bot system | [Link](docs/configuring-playbook-bot-maubot.md) |
|
||||
| [honoroit](https://github.com/etkecc/honoroit) | x | A helpdesk bot | [Link](docs/configuring-playbook-bot-honoroit.md) |
|
||||
| [Postmoogle](https://github.com/etkecc/postmoogle) | x | Email to matrix bot | [Link](docs/configuring-playbook-bot-postmoogle.md) |
|
||||
| [Postmoogle](https://github.com/etkecc/postmoogle) | x | Email to Matrix bot | [Link](docs/configuring-playbook-bot-postmoogle.md) |
|
||||
| [Go-NEB](https://github.com/matrix-org/go-neb) | x | A multi functional bot written in Go | [Link](docs/configuring-playbook-bot-go-neb.md) |
|
||||
| [Mjolnir](https://github.com/matrix-org/mjolnir) | x | A moderation tool for Matrix | [Link](docs/configuring-playbook-bot-mjolnir.md) |
|
||||
| [Draupnir](https://github.com/the-draupnir-project/Draupnir) | x | A moderation tool for Matrix (Fork of Mjolnir) | [Link](docs/configuring-playbook-bot-draupnir.md) |
|
||||
| [Buscarron](https://github.com/etkecc/buscarron) | x | Web forms (HTTP POST) to matrix | [Link](docs/configuring-playbook-bot-buscarron.md) |
|
||||
| [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) | x | ChatGPT from matrix | [Link](docs/configuring-playbook-bot-chatgpt.md) |
|
||||
| [Buscarron](https://github.com/etkecc/buscarron) | x | Web forms (HTTP POST) to Matrix | [Link](docs/configuring-playbook-bot-buscarron.md) |
|
||||
| [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) | x | ChatGPT from Matrix | [Link](docs/configuring-playbook-bot-chatgpt.md) |
|
||||
|
||||
### Administration
|
||||
|
||||
Services that help you in administrating and monitoring your matrix installation.
|
||||
Services that help you in administrating and monitoring your Matrix installation.
|
||||
|
||||
|
||||
| Name | Default? | Description | Documentation |
|
||||
@ -171,7 +171,7 @@ Various services that don't fit any other category.
|
||||
| [Matrix Corporal](https://github.com/devture/matrix-corporal) (advanced) | x | Reconciliator and gateway for a managed Matrix server | [Link](docs/configuring-playbook-matrix-corporal.md) |
|
||||
| [Etherpad](https://etherpad.org) | x | An open source collaborative text editor | [Link](docs/configuring-playbook-etherpad.md) |
|
||||
| [Jitsi](https://jitsi.org/) | x | An open source video-conferencing platform | [Link](docs/configuring-playbook-jitsi.md) |
|
||||
| [Cactus Comments](https://cactus.chat) | x | A federated comment system built on matrix | [Link](docs/configuring-playbook-cactus-comments.md) |
|
||||
| [Cactus Comments](https://cactus.chat) | x | A federated comment system built on Matrix | [Link](docs/configuring-playbook-cactus-comments.md) |
|
||||
| [Pantalaimon](https://github.com/matrix-org/pantalaimon) | x | An E2EE aware proxy daemon | [Link](docs/configuring-playbook-pantalaimon.md) |
|
||||
|
||||
|
||||
|
||||
@ -82,7 +82,7 @@ matrix_bot_draupnir_management_room: "ROOM_ID_FROM_STEP_4_GOES_HERE"
|
||||
The playbook's `group_vars` will configure other required settings. If using this role separately without the playbook, you also need to configure the two URLs that Draupnir uses to reach the homeserver, one through Pantalaimon and one "raw". This example is taken from the playbook's `group_vars`:
|
||||
|
||||
```yaml
|
||||
# Endpoint URL that Draupnir uses to interact with the matrix homeserver (client-server API).
|
||||
# Endpoint URL that Draupnir uses to interact with the Matrix homeserver (client-server API).
|
||||
# Set this to the pantalaimon URL if you're using that.
|
||||
matrix_bot_draupnir_homeserver_url: "{{ 'http://matrix-pantalaimon:8009' if matrix_bot_draupnir_pantalaimon_use else matrix_addons_homeserver_client_api_url }}"
|
||||
|
||||
|
||||
@ -46,7 +46,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bot, invite the `@honoroit:example.com` to the room you specified in config, after that any matrix user can send a message to the `@honoroit:example.com` to start a new thread in that room.
|
||||
To use the bot, invite the `@honoroit:example.com` to the room you specified in config, after that any Matrix user can send a message to the `@honoroit:example.com` to start a new thread in that room.
|
||||
|
||||
Send `!ho help` to the room to see the bot's help menu for additional commands.
|
||||
|
||||
|
||||
@ -41,7 +41,7 @@ After configuring the playbook, run the [installation](installing.md) command: `
|
||||
You can visit `matrix.example.com/_matrix/maubot/` to manage your available plugins, clients and instances.
|
||||
|
||||
You should start in the following order
|
||||
1. **Create one or more clients**: A client is a matrix account which the bot will use to message. By default, the playbook creates a `bot.maubot` account (as per the configuration above). You only need to [obtain an access token](#obtaining-an-access-token) for it
|
||||
1. **Create one or more clients**: A client is a Matrix account which the bot will use to message. By default, the playbook creates a `bot.maubot` account (as per the configuration above). You only need to [obtain an access token](#obtaining-an-access-token) for it
|
||||
2. **Upload some Plugins**: Plugins can be obtained from [here](https://github.com/maubot/maubot#plugins) or any other source.
|
||||
3. **Create an instance**: An instance is the actual bot. You have to specify a client which the bot instance will use
|
||||
and the plugin (how the bot will behave)
|
||||
|
||||
@ -76,7 +76,7 @@ matrix_bot_mjolnir_management_room: "ROOM_ID_FROM_STEP_4_GOES_HERE"
|
||||
The playbook's `group_vars` will configure other required settings. If using this role separately without the playbook, you also need to configure the two URLs that Mjolnir uses to reach the homeserver, one through Pantalaimon and one "raw". This example is taken from the playbook's `group_vars`:
|
||||
|
||||
```yaml
|
||||
# Endpoint URL that Mjolnir uses to interact with the matrix homeserver (client-server API).
|
||||
# Endpoint URL that Mjolnir uses to interact with the Matrix homeserver (client-server API).
|
||||
# Set this to the pantalaimon URL if you're using that.
|
||||
matrix_bot_mjolnir_homeserver_url: "{{ 'http://matrix-pantalaimon:8009' if matrix_bot_mjolnir_pantalaimon_use else matrix_addons_homeserver_client_api_url }}"
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ loosely based on [this](https://github.com/matrix-org/matrix-appservice-slack#Se
|
||||
|
||||
```yaml
|
||||
matrix_appservice_slack_enabled: true
|
||||
matrix_appservice_slack_control_room_id: "Your matrix admin room ID"
|
||||
matrix_appservice_slack_control_room_id: "Your Matrix admin room ID"
|
||||
```
|
||||
|
||||
3. Enable puppeting (optional, but recommended)
|
||||
@ -73,7 +73,7 @@ loosely based on [this](https://github.com/matrix-org/matrix-appservice-slack#Se
|
||||
|
||||
- files:write:user
|
||||
|
||||
**Note**: In order to make Slack files visible to matrix users, this bridge will make Slack files visible to anyone with the url (including files in private channels). This is different than the current behavior in Slack, which only allows authenticated access to media posted in private channels. See MSC701 for details.
|
||||
**Note**: In order to make Slack files visible to Matrix users, this bridge will make Slack files visible to anyone with the url (including files in private channels). This is different than the current behavior in Slack, which only allows authenticated access to media posted in private channels. See MSC701 for details.
|
||||
|
||||
10. Click on Install App and Install App to Workspace. Note the access tokens shown. You will need the Bot User OAuth Access Token and if you want to bridge files, the OAuth Access Token whenever you link a room.
|
||||
|
||||
@ -115,7 +115,7 @@ loosely based on [this](https://github.com/matrix-org/matrix-appservice-slack#Se
|
||||
unlink --room !the-matrix:room.id
|
||||
```
|
||||
|
||||
Unlinking doesn't only disconnect the bridge, but also makes the slackbot leave the bridged matrix room. So in case you want to re-link later, don't forget to re-invite the slackbot into this room again.
|
||||
Unlinking doesn't only disconnect the bridge, but also makes the slackbot leave the bridged Matrix room. So in case you want to re-link later, don't forget to re-invite the slackbot into this room again.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
@ -196,13 +196,13 @@ jitsi_jvb_container_colibri_ws_host_bind_port: 9090
|
||||
```
|
||||
|
||||
The JVB will also need to know where the prosody xmpp server is located, similar to the server ID this can be set in the vars for the JVB by using the variable
|
||||
`jitsi_xmpp_server`. The Jitsi prosody container is deployed on the matrix server by default so the value can be set to the matrix domain. For example:
|
||||
`jitsi_xmpp_server`. The Jitsi prosody container is deployed on the Matrix server by default so the value can be set to the Matrix domain. For example:
|
||||
|
||||
```yaml
|
||||
jitsi_xmpp_server: "{{ matrix_domain }}"
|
||||
```
|
||||
|
||||
However, it can also be set the ip address of the matrix server. This can be useful if you wish to use a private ip. For example:
|
||||
However, it can also be set the ip address of the Matrix server. This can be useful if you wish to use a private ip. For example:
|
||||
|
||||
```yaml
|
||||
jitsi_xmpp_server: "192.168.0.1"
|
||||
@ -269,7 +269,7 @@ jitsi_disable_gravatar: false
|
||||
```
|
||||
|
||||
**Beware**: This leaks information to a third party, namely the Gravatar-Service (unless configured otherwise: gravatar.com).
|
||||
Besides metadata, this includes the matrix user_id and possibly the room identifier (via `referrer` header).
|
||||
Besides metadata, this includes the Matrix user_id and possibly the room identifier (via `referrer` header).
|
||||
|
||||
## Installing
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ The playbook can install and configure [matrix-registration](https://github.com/
|
||||
|
||||
**WARNING**: this is not related to [matrix-registration-bot](configuring-playbook-bot-matrix-registration-bot.md)
|
||||
|
||||
> matrix-registration is a simple python application to have a token based matrix registration.
|
||||
> matrix-registration is a simple python application to have a token based Matrix registration.
|
||||
|
||||
Use matrix-registration to **create unique registration links**, which people can use to register on your Matrix server. It allows you to **keep your server's registration closed (private)**, but still allow certain people (these having a special link) to register a user account.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
The playbook can install and configure the [ntfy](https://ntfy.sh/) push notifications server for you.
|
||||
|
||||
Using the [UnifiedPush](https://unifiedpush.org) standard, ntfy enables self-hosted (Google-free) push notifications from Matrix (and other) servers to UnifiedPush-compatible matrix compatible client apps running on Android and other devices.
|
||||
Using the [UnifiedPush](https://unifiedpush.org) standard, ntfy enables self-hosted (Google-free) push notifications from Matrix (and other) servers to UnifiedPush-compatible Matrix compatible client apps running on Android and other devices.
|
||||
|
||||
This role is intended to support UnifiedPush notifications for use with the Matrix and Matrix-related services that this playbook installs. This role is not intended to support all of ntfy's other features.
|
||||
|
||||
@ -49,7 +49,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
|
||||
To make use of your ntfy installation, on Android for example, you need two things:
|
||||
|
||||
* the `ntfy` app
|
||||
* a UnifiedPush-compatible matrix app
|
||||
* a UnifiedPush-compatible Matrix app
|
||||
|
||||
You need to install the `ntfy` app on each device on which you want to receive push notifications through your ntfy server. The `ntfy` app will provide UnifiedPush notifications to any number of UnifiedPush-compatible messaging apps installed on the same device.
|
||||
|
||||
@ -61,11 +61,11 @@ You need to install the `ntfy` app on each device on which you want to receive p
|
||||
|
||||
That is all you need to do in the ntfy app. It has many other features, but for our purposes you can ignore them. In particular you do not need to follow any instructions about subscribing to a notification topic as UnifiedPush will do that automatically.
|
||||
|
||||
### Setting up a UnifiedPush-compatible matrix app
|
||||
### Setting up a UnifiedPush-compatible Matrix app
|
||||
|
||||
Install any UnifiedPush-enabled matrix app on that same device. The matrix app will learn from the `ntfy` app that you have configured UnifiedPush on this device, and then it will tell your matrix server to use it.
|
||||
Install any UnifiedPush-enabled Matrix app on that same device. The Matrix app will learn from the `ntfy` app that you have configured UnifiedPush on this device, and then it will tell your Matrix server to use it.
|
||||
|
||||
Steps needed for specific matrix apps:
|
||||
Steps needed for specific Matrix apps:
|
||||
|
||||
* FluffyChat-android:
|
||||
- Should auto-detect and use it. No manual settings.
|
||||
@ -79,9 +79,9 @@ Steps needed for specific matrix apps:
|
||||
1. choose `Settings` -> `Notifications` -> `Notification method` -> `ntfy`
|
||||
2. verify `Settings` -> `Troubleshoot` -> `Troubleshoot notification settings`
|
||||
|
||||
If the matrix app asks, "Choose a distributor: FCM Fallback or ntfy", then choose "ntfy".
|
||||
If the Matrix app asks, "Choose a distributor: FCM Fallback or ntfy", then choose "ntfy".
|
||||
|
||||
If the matrix app doesn't seem to pick it up, try restarting it and try the Troubleshooting section below.
|
||||
If the Matrix app doesn't seem to pick it up, try restarting it and try the Troubleshooting section below.
|
||||
|
||||
### Web App
|
||||
|
||||
@ -92,11 +92,11 @@ The web app is disabled in this playbook by default as the expectation is that m
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
First check that the matrix client app you are using supports UnifiedPush. There may well be different variants of the app.
|
||||
First check that the Matrix client app you are using supports UnifiedPush. There may well be different variants of the app.
|
||||
|
||||
Set the ntfy server's log level to 'DEBUG', as shown in the example settings above, and watch the server's logs with `sudo journalctl -fu matrix-ntfy`.
|
||||
|
||||
To check if UnifiedPush is correctly configured on the client device, look at "Settings -> Notifications -> Notification Targets" in Element-Android or SchildiChat, or "Settings -> Notifications -> Devices" in FluffyChat. There should be one entry for each matrix client app that has enabled push notifications, and when that client is using UnifiedPush you should see a URL that begins with your ntfy server's URL.
|
||||
To check if UnifiedPush is correctly configured on the client device, look at "Settings -> Notifications -> Notification Targets" in Element-Android or SchildiChat, or "Settings -> Notifications -> Devices" in FluffyChat. There should be one entry for each Matrix client app that has enabled push notifications, and when that client is using UnifiedPush you should see a URL that begins with your ntfy server's URL.
|
||||
|
||||
In the "Notification Targets" screen in Element-Android or SchildiChat, two relevant URLs are shown, "push\_key" and "Url", and both should begin with your ntfy server's URL. If "push\_key" shows your server but "Url" shows an external server such as `up.schildi.chat` then push notifications will still work but are being routed through that external server before they reach your ntfy server. To rectify that, in SchildiChat (at least around version 1.4.20.sc55) you must enable the `Force custom push gateway` setting as described in the "Usage" section above.
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@
|
||||
**[Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) (hereafter: 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) flow and come back here later.
|
||||
|
||||
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. Please refer to the documentation of the [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) to understand how it works.
|
||||
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. Please refer to the documentation of the [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) to understand how it works.
|
||||
|
||||
**Note**: enabling Matrix User Verification Service, 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.
|
||||
|
||||
@ -114,7 +114,7 @@ The configuration variable `UVS_LOG_LEVEL` can be set to:
|
||||
- debug
|
||||
|
||||
## TLS Certificate Checking
|
||||
If the matrix Homeserver does not provide a valid TLS certificate, UVS will fail with the following error message:
|
||||
If the Matrix Homeserver does not provide a valid TLS certificate, UVS will fail with the following error message:
|
||||
|
||||
> message: 'No response received: [object Object]',
|
||||
|
||||
|
||||
@ -81,7 +81,7 @@ When you're done with all the configuration you'd like to do, continue with [Ins
|
||||
|
||||
- [Adjusting email-sending settings](configuring-playbook-email.md) (optional)
|
||||
|
||||
- [Setting up Hydrogen](configuring-playbook-client-hydrogen.md) - a new lightweight matrix client with legacy and mobile browser support (optional)
|
||||
- [Setting up Hydrogen](configuring-playbook-client-hydrogen.md) - a new lightweight Matrix client with legacy and mobile browser support (optional)
|
||||
|
||||
- [Setting up Cinny](configuring-playbook-client-cinny.md) - a web client focusing primarily on simple, elegant and secure interface (optional)
|
||||
|
||||
|
||||
@ -161,7 +161,7 @@ frontend www-https
|
||||
# Use the challenge backend if the challenge is set
|
||||
use_backend matrix-backend if matrix-acl
|
||||
backend matrix-backend
|
||||
# Redirects the .well-known matrix to the matrix server for federation.
|
||||
# Redirects the .well-known Matrix to the Matrix server for federation.
|
||||
http-request set-header Host matrix.example.com
|
||||
server matrix matrix.example.com:80
|
||||
# Map url path as ProxyPass does
|
||||
|
||||
@ -42,7 +42,7 @@ These services are not part of our default installation, but can be enabled by [
|
||||
|
||||
- [devture/matrix-corporal](https://hub.docker.com/r/devture/matrix-corporal/) - [Matrix Corporal](https://github.com/devture/matrix-corporal): reconciliator and gateway for a managed Matrix server (optional)
|
||||
|
||||
- [zeratax/matrix-registration](https://hub.docker.com/r/devture/zeratax-matrix-registration/) - [matrix-registration](https://github.com/ZerataX/matrix-registration): a simple python application to have a token based matrix registration (optional)
|
||||
- [zeratax/matrix-registration](https://hub.docker.com/r/devture/zeratax-matrix-registration/) - [matrix-registration](https://github.com/ZerataX/matrix-registration): a simple python application to have a token based Matrix registration (optional)
|
||||
|
||||
- [mautrix/telegram](https://mau.dev/mautrix/telegram/container_registry) - the [mautrix-telegram](https://github.com/mautrix/telegram) bridge to [Telegram](https://telegram.org/) (optional)
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ Server Delegation by means of a `/.well-known/matrix/server` file is the most st
|
||||
|
||||
- you need to have a working HTTPS server for the base domain (`example.com`). If you don't have any server for the base domain at all, you can easily solve it by making the playbook [serve the base domain from the Matrix server](configuring-playbook-base-domain-serving.md).
|
||||
|
||||
- any downtime on the base domain (`example.com`) or network trouble between the matrix subdomain (`matrix.example.com`) and the base `example.com` may cause Matrix Federation outages. As the [Server-Server spec says](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery):
|
||||
- any downtime on the base domain (`example.com`) or network trouble between the Matrix subdomain (`matrix.example.com`) and the base `example.com` may cause Matrix Federation outages. As the [Server-Server spec says](https://matrix.org/docs/spec/server_server/r0.1.0.html#server-discovery):
|
||||
|
||||
> Errors are recommended to be cached for up to an hour, and servers are encouraged to exponentially back off for repeated failures.
|
||||
|
||||
|
||||
@ -36,7 +36,7 @@ This is because with SRV federation, some servers / tools (one of which being th
|
||||
|
||||
Now that the federation endpoint is not bound to a domain anymore we need to explicitely tell Traefik to use a wildcard certificate in addition to one containing the base name.
|
||||
|
||||
This is because the matrix specification expects the federation endpoint to be served using a certificate compatible with the base domain, however, the other resources on the endpoint still need a valid certificate to work.
|
||||
This is because the Matrix specification expects the federation endpoint to be served using a certificate compatible with the base domain, however, the other resources on the endpoint still need a valid certificate to work.
|
||||
|
||||
```yaml
|
||||
# To let Traefik know which domains' certificates to serve
|
||||
|
||||
@ -51,7 +51,7 @@ When the [Synapse Admin API](https://github.com/element-hq/synapse/tree/master/d
|
||||
|
||||
Editing the database manually is not recommended or supported by the Synapse developers. If you are going to do so you should [make a database backup](./maintenance-postgres.md#backing-up-postgresql).
|
||||
|
||||
First, set up an SSH tunnel to your matrix server (skip if it is your local machine):
|
||||
First, set up an SSH tunnel to your Matrix server (skip if it is your local machine):
|
||||
|
||||
```
|
||||
# you may replace 1799 with an arbitrary port unbound on both machines
|
||||
|
||||
@ -13,4 +13,4 @@ To get started, first follow the [front the integrated reverse-proxy webserver w
|
||||
You can either just use the [Caddyfile](Caddyfile) directly or append its content to your own Caddyfile.
|
||||
In both cases make sure to replace all the `example.com` domains with your own domain.
|
||||
|
||||
This example does not include additional services like element, but you should be able copy the first block and replace the matrix subdomain with the additional services subdomain. I have not tested this though.
|
||||
This example does not include additional services like element, but you should be able copy the first block and replace the `matrix` subdomain with the additional services subdomain. I have not tested this though.
|
||||
|
||||
@ -14,9 +14,9 @@ If Matrix federation is enabled, then you will need to make changes to [NPM's Do
|
||||
|
||||
## Using Nginx Proxy Manager
|
||||
|
||||
You'll need to create two proxy hosts in NPM for matrix web and federation traffic.
|
||||
You'll need to create two proxy hosts in NPM for Matrix web and federation traffic.
|
||||
|
||||
Open the 'Proxy Hosts' page in the NPM web interface and select `Add Proxy Host`, the first being for matrix web traffic. Apply the proxys configuration like this:
|
||||
Open the 'Proxy Hosts' page in the NPM web interface and select `Add Proxy Host`, the first being for Matrix web traffic. Apply the proxys configuration like this:
|
||||
|
||||
```md
|
||||
# Details
|
||||
|
||||
@ -45,7 +45,7 @@ server {
|
||||
ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem; # managed by Certbot
|
||||
}
|
||||
|
||||
# settings for matrix federation
|
||||
# settings for Matrix federation
|
||||
server {
|
||||
# For the federation port
|
||||
# TODO: once per IP and port you should add `reuseport`, if you don't have that in any other nginx config file, add it here by uncommenting the lines below and commenting the one after with `quic` but without `reuseport`
|
||||
|
||||
@ -2650,7 +2650,7 @@ matrix_bot_honoroit_container_labels_traefik_docker_network: "{{ matrix_playbook
|
||||
matrix_bot_honoroit_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}"
|
||||
matrix_bot_honoroit_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}"
|
||||
|
||||
# For consistency with other things hosted at the matrix FQN, we adjust the metrics endpoint
|
||||
# For consistency with other things hosted at the Matrix FQN, we adjust the metrics endpoint
|
||||
# so that metrics would be served at something like `/metrics/SERVICE_NAME`, and not at the default path for the role (`PREFIX/metrics`).
|
||||
matrix_bot_honoroit_container_labels_traefik_metrics_path: "{{ matrix_metrics_exposure_path_prefix }}/honoroit"
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
homeserver:
|
||||
# The Matrix server name, this will be the name of the server in your matrix ID.
|
||||
# The Matrix server name, this will be the name of the server in your Matrix ID.
|
||||
domain: "{{ matrix_domain }}"
|
||||
# The url for the appservice to call the client server API from.
|
||||
url: "{{ matrix_homeserver_url }}"
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
# Example value: example.com
|
||||
matrix_domain: ~
|
||||
|
||||
# The optional matrix admin MXID, used in bridges' configs to set bridge admin user
|
||||
# The optional Matrix admin MXID, used in bridges' configs to set bridge admin user
|
||||
# Example value: "@someone:{{ matrix_domain }}"
|
||||
matrix_admin: ''
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ if [ "$sure" != "Yes, I really want to remove everything!" ]; then
|
||||
echo "Good thing I asked, exiting"
|
||||
exit 0
|
||||
else
|
||||
echo "Stop and remove matrix services"
|
||||
echo "Stop and remove Matrix services"
|
||||
|
||||
for s in $(find {{ devture_systemd_docker_base_systemd_path }}/ -type f -name "matrix-*" -printf "%f\n"); do
|
||||
systemctl disable --now $s
|
||||
@ -32,4 +32,3 @@ else
|
||||
rm -fr "{{ matrix_base_data_path }}"
|
||||
exit 0
|
||||
fi
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
# chatgpt is a bot for chatting to openAI chatgpt matrix bot
|
||||
# chatgpt is a bot for chatting to openAI chatgpt Matrix bot
|
||||
# Project source code URL: https://github.com/matrixgpt/matrix-chatgpt-bot
|
||||
|
||||
matrix_bot_chatgpt_enabled: true
|
||||
|
||||
@ -66,7 +66,7 @@ matrix_bot_draupnir_pantalaimon_password: ""
|
||||
# Note: Draupnir is fairly verbose - expect a lot of messages from it.
|
||||
matrix_bot_draupnir_management_room: ""
|
||||
|
||||
# Endpoint URL that Draupnir uses to interact with the matrix homeserver (client-server API).
|
||||
# Endpoint URL that Draupnir uses to interact with the Matrix homeserver (client-server API).
|
||||
# Set this to the pantalaimon URL if you're using that.
|
||||
matrix_bot_draupnir_homeserver_url: ""
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Endpoint URL that Draupnir uses to interact with the matrix homeserver (client-server API),
|
||||
# Endpoint URL that Draupnir uses to interact with the Matrix homeserver (client-server API),
|
||||
# set this to the pantalaimon URL if you're using that.
|
||||
homeserverUrl: {{ matrix_bot_draupnir_homeserver_url | to_json }}
|
||||
|
||||
@ -12,7 +12,7 @@ accessToken: {{ matrix_bot_draupnir_access_token | to_json }}
|
||||
{% if matrix_bot_draupnir_pantalaimon_use %}
|
||||
# Options related to Pantalaimon (https://github.com/matrix-org/pantalaimon)
|
||||
pantalaimon:
|
||||
# Whether or not Draupnir will use pantalaimon to access the matrix homeserver,
|
||||
# Whether or not Draupnir will use pantalaimon to access the Matrix homeserver,
|
||||
# set to `true` if you're using pantalaimon.
|
||||
#
|
||||
# Be sure to point homeserverUrl to the pantalaimon instance.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
# matrix-registration-bot creates and manages registration tokens for a matrix server
|
||||
# matrix-registration-bot creates and manages registration tokens for a Matrix server
|
||||
# Project source code URL: https://github.com/moan0s/matrix-registration-bot
|
||||
|
||||
matrix_bot_matrix_registration_bot_enabled: true
|
||||
|
||||
@ -57,7 +57,7 @@ matrix_bot_mjolnir_pantalaimon_password: ""
|
||||
# Note: Mjolnir is fairly verbose - expect a lot of messages from it.
|
||||
matrix_bot_mjolnir_management_room: ""
|
||||
|
||||
# Endpoint URL that Mjolnir uses to interact with the matrix homeserver (client-server API).
|
||||
# Endpoint URL that Mjolnir uses to interact with the Matrix homeserver (client-server API).
|
||||
# Set this to the pantalaimon URL if you're using that.
|
||||
matrix_bot_mjolnir_homeserver_url: ""
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Endpoint URL that Mjolnir uses to interact with the matrix homeserver (client-server API),
|
||||
# Endpoint URL that Mjolnir uses to interact with the Matrix homeserver (client-server API),
|
||||
# set this to the pantalaimon URL if you're using that.
|
||||
homeserverUrl: {{ matrix_bot_mjolnir_homeserver_url | to_json }}
|
||||
|
||||
@ -12,7 +12,7 @@ accessToken: {{ matrix_bot_mjolnir_access_token | to_json }}
|
||||
{% if matrix_bot_mjolnir_pantalaimon_use %}
|
||||
# Options related to Pantalaimon (https://github.com/matrix-org/pantalaimon)
|
||||
pantalaimon:
|
||||
# Whether or not Mjolnir will use pantalaimon to access the matrix homeserver,
|
||||
# Whether or not Mjolnir will use pantalaimon to access the Matrix homeserver,
|
||||
# set to `true` if you're using pantalaimon.
|
||||
#
|
||||
# Be sure to point homeserverUrl to the pantalaimon instance.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
# postmoogle is an email to matrix bot
|
||||
# postmoogle is an email to Matrix bot
|
||||
# Project source code URL: https://github.com/etkecc/postmoogle
|
||||
|
||||
matrix_bot_postmoogle_enabled: true
|
||||
|
||||
@ -61,7 +61,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
|
||||
# # The address of the server to connect to.
|
||||
# irc.example.com:
|
||||
# # A human-readable short name. This is used to label IRC status rooms
|
||||
# # where matrix users control their connections.
|
||||
# # where Matrix users control their connections.
|
||||
# # E.g. 'ExampleNet IRC Bridge status'.
|
||||
# # It is also used in the Third Party Lookup API as the instance `desc`
|
||||
# # property, where each server is an instance.
|
||||
@ -158,7 +158,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
|
||||
# #
|
||||
# # Join channels even if there are no Matrix users on the other side of
|
||||
# # the bridge. Set to false to prevent the bot from joining channels which have no
|
||||
# # real matrix users in them, even if there is a mapping for the channel.
|
||||
# # real Matrix users in them, even if there is a mapping for the channel.
|
||||
# # Default: true
|
||||
# joinChannelsIfNoUsers: true
|
||||
|
||||
@ -239,9 +239,9 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
|
||||
# global:
|
||||
# ircToMatrix:
|
||||
# # Get a snapshot of all real IRC users on a channel (via NAMES) and
|
||||
# # join their virtual matrix clients to the room.
|
||||
# # join their virtual Matrix clients to the room.
|
||||
# initial: false
|
||||
# # Make virtual matrix clients join and leave rooms as their real IRC
|
||||
# # Make virtual Matrix clients join and leave rooms as their real IRC
|
||||
# # counterparts join/part channels. Default: false.
|
||||
# incremental: false
|
||||
|
||||
@ -270,25 +270,25 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
|
||||
|
||||
# mappings:
|
||||
# # 1:many mappings from IRC channels to room IDs on this IRC server.
|
||||
# # The matrix room must already exist. Your matrix client should expose
|
||||
# # The Matrix room must already exist. Your Matrix client should expose
|
||||
# # the room ID in a "settings" page for the room.
|
||||
# "#thepub":
|
||||
# roomIds: ["!kieouiJuedJoxtVdaG:localhost"]
|
||||
# # Channel key/password to use. Optional. If provided, matrix users do
|
||||
# # Channel key/password to use. Optional. If provided, Matrix users do
|
||||
# # not need to know the channel key in order to join the channel.
|
||||
# # key: "secret"
|
||||
|
||||
# # Configuration for virtual matrix users. The following variables are
|
||||
# # Configuration for virtual Matrix users. The following variables are
|
||||
# # exposed:
|
||||
# # $NICK => The IRC nick
|
||||
# # $SERVER => The IRC server address (e.g. "irc.example.com")
|
||||
# matrixClients:
|
||||
# # The user ID template to use when creating virtual matrix users. This
|
||||
# # The user ID template to use when creating virtual Matrix users. This
|
||||
# # MUST have $NICK somewhere in it.
|
||||
# # Optional. Default: "@$SERVER_$NICK".
|
||||
# # Example: "@irc.example.com_Alice:example.com"
|
||||
# userTemplate: "@irc_$NICK"
|
||||
# # The display name to use for created matrix clients. This should have
|
||||
# # The display name to use for created Matrix clients. This should have
|
||||
# # $NICK somewhere in it if it is specified. Can also use $SERVER to
|
||||
# # insert the IRC domain.
|
||||
# # Optional. Default: "$NICK (IRC)". Example: "Alice (IRC)"
|
||||
@ -333,7 +333,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
|
||||
# # The maximum amount of time in seconds that the client can exist
|
||||
# # without sending another message before being disconnected. Use 0 to
|
||||
# # not apply an idle timeout. This value is ignored if this IRC server is
|
||||
# # mirroring matrix membership lists to IRC. Default: 172800 (48 hours)
|
||||
# # mirroring Matrix membership lists to IRC. Default: 172800 (48 hours)
|
||||
# idleTimeout: 10800
|
||||
# # The number of millseconds to wait between consecutive reconnections if a
|
||||
# # client gets disconnected. Setting to 0 will cause the scheduling to be
|
||||
@ -353,7 +353,7 @@ matrix_appservice_irc_ircService_servers: [] # noqa var-naming
|
||||
# concurrentReconnectLimit: 50
|
||||
# # The number of lines to allow being sent by the IRC client that has received
|
||||
# # a large block of text to send from matrix. If the number of lines that would
|
||||
# # be sent is > lineLimit, the text will instead be uploaded to matrix and the
|
||||
# # be sent is > lineLimit, the text will instead be uploaded to Matrix and the
|
||||
# # resulting URI is treated as a file. As such, a link will be sent to the IRC
|
||||
# # side instead of potentially spamming IRC and getting the IRC client kicked.
|
||||
# # Default: 3.
|
||||
|
||||
@ -26,7 +26,7 @@ homeserver:
|
||||
# is the "domain name" part of the HS URL.
|
||||
domain: {{ matrix_appservice_irc_homeserver_domain }}
|
||||
|
||||
# Should presence be enabled for matrix clients on this bridge. If disabled on the
|
||||
# Should presence be enabled for Matrix clients on this bridge. If disabled on the
|
||||
# homeserver then it should also be disabled here to avoid excess traffic.
|
||||
# Default: true
|
||||
enablePresence: {{ matrix_appservice_irc_homeserver_enablePresence|to_json }}
|
||||
@ -47,17 +47,17 @@ ircService:
|
||||
|
||||
# Config for Matrix -> IRC bridging
|
||||
matrixHandler:
|
||||
# Cache this many matrix events in memory to be used for m.relates_to messages (usually replies).
|
||||
# Cache this many Matrix events in memory to be used for m.relates_to messages (usually replies).
|
||||
eventCacheSize: 4096
|
||||
|
||||
servers: {{ matrix_appservice_irc_ircService_servers|to_json }}
|
||||
|
||||
# Configuration for an ident server. If you are running a public bridge it is
|
||||
# advised you setup an ident server so IRC mods can ban specific matrix users
|
||||
# advised you setup an ident server so IRC mods can ban specific Matrix users
|
||||
# rather than the application service itself.
|
||||
ident:
|
||||
# True to listen for Ident requests and respond with the
|
||||
# matrix user's user_id (converted to ASCII, respecting RFC 1413).
|
||||
# Matrix user's user_id (converted to ASCII, respecting RFC 1413).
|
||||
# Default: false.
|
||||
enabled: false
|
||||
# The port to listen on for incoming ident requests.
|
||||
|
||||
@ -82,7 +82,7 @@
|
||||
path: "{{ matrix_go_skype_bridge_base_path }}/go-skype-bridge.db"
|
||||
register: matrix_go_skype_bridge_stat_database
|
||||
|
||||
- name: Check if an old matrix state file exists
|
||||
- name: Check if an old Matrix state file exists
|
||||
ansible.builtin.stat:
|
||||
path: "{{ matrix_go_skype_bridge_base_path }}/mx-state.json"
|
||||
register: matrix_go_skype_bridge_stat_mx_state
|
||||
|
||||
@ -109,7 +109,7 @@ bridge:
|
||||
|
||||
# Number of chats to sync for new users.
|
||||
# Since some of the obtained conversations are not the conversations that the user needs to see,
|
||||
# the actual number of conversations displayed on the matrix client will be slightly less than the set value
|
||||
# the actual number of conversations displayed on the Matrix client will be slightly less than the set value
|
||||
initial_chat_sync_count: 10
|
||||
# Number of old messages to fill when creating new portal rooms.
|
||||
initial_history_fill_count: 20
|
||||
@ -181,7 +181,7 @@ bridge:
|
||||
default: {{ matrix_go_skype_bridge_bridge_encryption_default|to_json }}
|
||||
|
||||
puppet_id:
|
||||
# when set to true, the matrixid of the contact (puppet) from the bridge to the matrix will be encrypted into another string
|
||||
# when set to true, the matrixid of the contact (puppet) from the bridge to the Matrix will be encrypted into another string
|
||||
allow: false
|
||||
# 8 characters
|
||||
key: '12dsf323'
|
||||
|
||||
@ -82,7 +82,7 @@
|
||||
path: "{{ matrix_mautrix_gmessages_base_path }}/mautrix-gmessages.db"
|
||||
register: matrix_mautrix_gmessages_stat_database
|
||||
|
||||
- name: Check if an old matrix state file exists
|
||||
- name: Check if an old Matrix state file exists
|
||||
ansible.builtin.stat:
|
||||
path: "{{ matrix_mautrix_gmessages_base_path }}/mx-state.json"
|
||||
register: matrix_mautrix_gmessages_stat_mx_state
|
||||
|
||||
@ -82,7 +82,7 @@
|
||||
path: "{{ matrix_mautrix_signal_base_path }}/mautrix-signal.db"
|
||||
register: matrix_mautrix_signal_stat_database
|
||||
|
||||
- name: Check if an old matrix state file exists
|
||||
- name: Check if an old Matrix state file exists
|
||||
ansible.builtin.stat:
|
||||
path: "{{ matrix_mautrix_signal_base_path }}/mx-state.json"
|
||||
register: matrix_mautrix_signal_stat_mx_state
|
||||
|
||||
@ -82,7 +82,7 @@
|
||||
path: "{{ matrix_mautrix_whatsapp_base_path }}/mautrix-whatsapp.db"
|
||||
register: matrix_mautrix_whatsapp_stat_database
|
||||
|
||||
- name: Check if an old matrix state file exists
|
||||
- name: Check if an old Matrix state file exists
|
||||
ansible.builtin.stat:
|
||||
path: "{{ matrix_mautrix_whatsapp_base_path }}/mx-state.json"
|
||||
register: matrix_mautrix_whatsapp_stat_mx_state
|
||||
|
||||
@ -62,7 +62,7 @@
|
||||
- "{{ matrix_mautrix_wsproxy_base_path }}"
|
||||
- "{{ matrix_mautrix_wsproxy_config_path }}"
|
||||
|
||||
- name: Check if an old matrix state file exists
|
||||
- name: Check if an old Matrix state file exists
|
||||
ansible.builtin.stat:
|
||||
path: "{{ matrix_mautrix_wsproxy_base_path }}/mx-state.json"
|
||||
register: matrix_mautrix_wsproxy_stat_mx_state
|
||||
|
||||
@ -781,7 +781,7 @@ matrix_media_repo_rate_limit_buckets_download_drain_bytes_per_minute: 5242880 #
|
||||
matrix_media_repo_rate_limit_buckets_download_overflow_limit_bytes: 104857600 # 100mb default (the same as the default remote download maxBytes)
|
||||
|
||||
# Identicons are generated avatars for a given username. Some clients use these to give users a
|
||||
# default avatar after signing up. Identicons are not part of the official matrix spec, therefore
|
||||
# default avatar after signing up. Identicons are not part of the official Matrix spec, therefore
|
||||
# this feature is completely optional.
|
||||
matrix_media_repo_identicons_enabled: true
|
||||
|
||||
|
||||
@ -517,7 +517,7 @@ rateLimit:
|
||||
|
||||
|
||||
# Identicons are generated avatars for a given username. Some clients use these to give users a
|
||||
# default avatar after signing up. Identicons are not part of the official matrix spec, therefore
|
||||
# default avatar after signing up. Identicons are not part of the official Matrix spec, therefore
|
||||
# this feature is completely optional.
|
||||
identicons:
|
||||
enabled: {{ matrix_media_repo_identicons_enabled | to_json }}
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
# E2EE aware proxy daemon for matrix clients.
|
||||
# E2EE aware proxy daemon for Matrix clients.
|
||||
# Project source code URL: https://github.com/matrix-org/pantalaimon
|
||||
|
||||
matrix_pantalaimon_enabled: true
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
# matrix-registration is a simple python application to have a token based matrix registration
|
||||
# matrix-registration is a simple python application to have a token based Matrix registration
|
||||
# See: https://zeratax.github.io/matrix-registration/
|
||||
# Project source code URL: https://github.com/ZerataX/matrix-registration
|
||||
|
||||
|
||||
@ -48,7 +48,7 @@ matrix_static_files_container_labels_traefik_docker_network: "{{ matrix_static_f
|
||||
matrix_static_files_container_labels_traefik_entrypoints: web-secure
|
||||
matrix_static_files_container_labels_traefik_tls_certResolver: default # noqa var-naming
|
||||
|
||||
# Controls whether labels will be added that expose the well-known public endpoint on the matrix domain.
|
||||
# Controls whether labels will be added that expose the well-known public endpoint on the Matrix domain.
|
||||
matrix_static_files_container_labels_well_known_matrix_endpoint_enabled: true
|
||||
matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_hostname: ''
|
||||
matrix_static_files_container_labels_well_known_matrix_endpoint_traefik_path_prefix: /.well-known/matrix
|
||||
@ -234,7 +234,7 @@ matrix_static_files_file_matrix_client_configuration: "{{ matrix_static_files_fi
|
||||
# If you wish to rely on DNS SRV records only, you can disable this.
|
||||
# Using DNS SRV records implies that you'll be handling Matrix Federation API traffic (tcp/8448)
|
||||
# using certificates for the base domain (`matrix_domain`) and not for the
|
||||
# matrix domain (`matrix_server_fqn_matrix`).
|
||||
# Matrix domain (`matrix_server_fqn_matrix`).
|
||||
matrix_static_files_file_matrix_server_enabled: true
|
||||
|
||||
# Controls the m.server property in the /.well-known/matrix/server file
|
||||
|
||||
@ -6,7 +6,7 @@
|
||||
|
||||
# These well-known files may be served without a `Content-Type: application/json` header,
|
||||
# so we can't rely on the uri module's automatic parsing of JSON.
|
||||
- name: Check .well-known on the matrix hostname
|
||||
- name: Check .well-known on the Matrix hostname
|
||||
ansible.builtin.uri:
|
||||
url: "{{ well_known_url_matrix }}"
|
||||
follow_redirects: none
|
||||
@ -18,21 +18,21 @@
|
||||
register: result_well_known_matrix
|
||||
ignore_errors: true
|
||||
|
||||
- name: Fail if .well-known not working on the matrix hostname
|
||||
- name: Fail if .well-known not working on the Matrix hostname
|
||||
ansible.builtin.fail:
|
||||
msg: "Failed checking that the well-known file for {{ well_known_file_check.purpose }} is configured at `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ well_known_url_matrix }}`). Is port 443 open in your firewall? Full error: {{ result_well_known_matrix }}"
|
||||
when: "result_well_known_matrix.failed"
|
||||
|
||||
- name: Parse JSON for well-known payload at the matrix hostname
|
||||
- name: Parse JSON for well-known payload at the Matrix hostname
|
||||
ansible.builtin.set_fact:
|
||||
well_known_matrix_payload: "{{ result_well_known_matrix.content | from_json }}"
|
||||
|
||||
- name: Fail if .well-known not CORS-aware on the matrix hostname
|
||||
- name: Fail if .well-known not CORS-aware on the Matrix hostname
|
||||
ansible.builtin.fail:
|
||||
msg: "The well-known file for {{ well_known_file_check.purpose }} on `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ well_known_url_matrix }}`) is not CORS-aware. The file needs to be served with an Access-Control-Allow-Origin header set."
|
||||
when: "well_known_file_check.cors and 'access_control_allow_origin' not in result_well_known_matrix"
|
||||
|
||||
- name: Report working .well-known on the matrix hostname
|
||||
- name: Report working .well-known on the Matrix hostname
|
||||
ansible.builtin.debug:
|
||||
msg: "well-known for {{ well_known_file_check.purpose }} is configured correctly for `{{ matrix_server_fqn_matrix }}` (checked endpoint: `{{ well_known_url_matrix }}`)"
|
||||
|
||||
@ -63,7 +63,7 @@
|
||||
when: "well_known_file_check.cors and 'access_control_allow_origin' not in result_well_known_identity"
|
||||
|
||||
# For people who manually copy the well-known file, try to detect if it's outdated
|
||||
- name: Fail if well-known is different on matrix hostname and identity hostname
|
||||
- name: Fail if well-known is different on Matrix hostname and identity hostname
|
||||
ansible.builtin.fail:
|
||||
msg: "The well-known files for {{ well_known_file_check.purpose }} at `{{ matrix_server_fqn_matrix }}` and `{{ matrix_domain }}` are different. Perhaps you copied the file ({{ well_known_file_check.path }}) manually before and now it's outdated?"
|
||||
when: "well_known_matrix_payload != well_known_identity_payload"
|
||||
|
||||
@ -11,7 +11,7 @@ traefik.http.services.{{ matrix_static_files_identifier }}.loadbalancer.server.p
|
||||
{% if matrix_static_files_container_labels_well_known_matrix_endpoint_enabled %}
|
||||
############################################################
|
||||
# #
|
||||
# Related to /.well-known/matrix on the matrix domain #
|
||||
# Related to /.well-known/matrix on the Matrix domain #
|
||||
# #
|
||||
############################################################
|
||||
|
||||
@ -43,7 +43,7 @@ traefik.http.routers.{{ matrix_static_files_identifier }}-well-known.tls.certRes
|
||||
|
||||
############################################################
|
||||
# #
|
||||
# /Related to /.well-known/matrix on the matrix domain #
|
||||
# /Related to /.well-known/matrix on the Matrix domain #
|
||||
# #
|
||||
############################################################
|
||||
{% endif %}
|
||||
|
||||
@ -1183,7 +1183,7 @@ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_invites: true
|
||||
# this means that spammy messages will appear as empty to users. Default
|
||||
# false.
|
||||
matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_messages: false
|
||||
# Remove users from the user directory search by filtering matrix IDs and
|
||||
# Remove users from the user directory search by filtering Matrix IDs and
|
||||
# display names by the entries in the user ban list. Default false.
|
||||
matrix_synapse_ext_spam_checker_mjolnir_antispam_config_block_usernames: false
|
||||
# The room IDs of the ban lists to honour. Unlike other parts of Mjolnir,
|
||||
|
||||
@ -32,7 +32,7 @@ modules: {{ matrix_synapse_modules|to_json }}
|
||||
# created on this server. For example if the server_name was example.com,
|
||||
# usernames on this server would be in the format @user:example.com
|
||||
#
|
||||
# In most cases you should avoid using a matrix specific subdomain such as
|
||||
# In most cases you should avoid using a Matrix specific subdomain such as
|
||||
# matrix.example.com or synapse.example.com as the server_name for the same
|
||||
# reasons you wouldn't use user@email.example.com as your email address.
|
||||
# See https://matrix-org.github.io/synapse/latest/delegate.html
|
||||
@ -293,7 +293,7 @@ listeners:
|
||||
{% endif %}
|
||||
|
||||
{% if matrix_synapse_federation_port_enabled and matrix_synapse_tls_federation_listener_enabled %}
|
||||
# TLS-enabled listener: for when matrix traffic is sent directly to synapse.
|
||||
# TLS-enabled listener: for when Matrix traffic is sent directly to synapse.
|
||||
- port: {{ matrix_synapse_container_federation_api_tls_port|to_json }}
|
||||
tls: true
|
||||
bind_addresses: ['::']
|
||||
@ -305,7 +305,7 @@ listeners:
|
||||
compress: false
|
||||
{% endif %}
|
||||
|
||||
# Unsecure HTTP listener (Client API): for when matrix traffic passes through a reverse proxy
|
||||
# Unsecure HTTP listener (Client API): for when Matrix traffic passes through a reverse proxy
|
||||
# that unwraps TLS.
|
||||
- port: {{ matrix_synapse_container_client_api_port|to_json }}
|
||||
tls: false
|
||||
@ -318,7 +318,7 @@ listeners:
|
||||
compress: false
|
||||
|
||||
{% if matrix_synapse_federation_port_enabled %}
|
||||
# Unsecure HTTP listener (Federation API): for when matrix traffic passes through a reverse proxy
|
||||
# Unsecure HTTP listener (Federation API): for when Matrix traffic passes through a reverse proxy
|
||||
# that unwraps TLS.
|
||||
- port: {{ matrix_synapse_container_federation_api_plain_port|to_json }}
|
||||
tls: false
|
||||
@ -1873,7 +1873,7 @@ saml2_config:
|
||||
#saml_session_lifetime: 5m
|
||||
|
||||
# An external module can be provided here as a custom solution to
|
||||
# mapping attributes returned from a saml provider onto a matrix user.
|
||||
# mapping attributes returned from a saml provider onto a Matrix user.
|
||||
#
|
||||
user_mapping_provider:
|
||||
# The custom module's class. Uncomment to use a custom module.
|
||||
@ -1896,7 +1896,7 @@ saml2_config:
|
||||
#mxid_source_attribute: displayName
|
||||
|
||||
# The mapping system to use for mapping the saml attribute onto a
|
||||
# matrix ID.
|
||||
# Matrix ID.
|
||||
#
|
||||
# Options include:
|
||||
# * 'hexencode' (which maps unpermitted characters to '=xx')
|
||||
@ -2037,7 +2037,7 @@ saml2_config:
|
||||
# switching from password logins to OIDC. Defaults to false.
|
||||
#
|
||||
# user_mapping_provider: Configuration for how attributes returned from a OIDC
|
||||
# provider are mapped onto a matrix user. This setting has the following
|
||||
# provider are mapped onto a Matrix user. This setting has the following
|
||||
# sub-properties:
|
||||
#
|
||||
# module: The class name of a custom mapping module. Default is
|
||||
@ -2831,7 +2831,7 @@ opentracing:
|
||||
#homeserver_whitelist:
|
||||
# - ".*"
|
||||
|
||||
# A list of the matrix IDs of users whose requests will always be traced,
|
||||
# A list of the Matrix IDs of users whose requests will always be traced,
|
||||
# even if the tracing system would otherwise drop the traces due to
|
||||
# probabilistic sampling.
|
||||
#
|
||||
|
||||
@ -66,7 +66,7 @@ matrix_user_verification_service_uvs_auth_token: ''
|
||||
# Pin UVS to only check openId Tokens for the matrix_server_name configured by this playbook.
|
||||
matrix_user_verification_service_uvs_pin_openid_verify_server_name: true
|
||||
# Matrix server name to verify OpenID tokens against.
|
||||
# This is not the homeserverURL, but rather the domain in the matrix "user ID"
|
||||
# This is not the homeserverURL, but rather the domain in the Matrix "user ID"
|
||||
# UVS can also be instructed to verify against the Matrix server name passed in the token, to enable set to ""
|
||||
matrix_user_verification_service_uvs_openid_verify_server_name: "{{ matrix_domain }}"
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
---
|
||||
|
||||
- name: Find leftover matrix scripts in /usr/local/bin
|
||||
- name: Find leftover Matrix scripts in /usr/local/bin
|
||||
ansible.builtin.find:
|
||||
path: "/usr/local/bin"
|
||||
patterns:
|
||||
@ -19,7 +19,7 @@
|
||||
- matrix-synapse-worker-write-pid
|
||||
register: matrix_usr_local_bin_files_result
|
||||
|
||||
- name: Ensure /usr/local/bin does not contain matrix scripts
|
||||
- name: Ensure /usr/local/bin does not contain Matrix scripts
|
||||
ansible.builtin.file:
|
||||
path: "{{ item.path }}"
|
||||
state: absent
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
|
||||
- name: Ensure matrix-ssl files are deleted
|
||||
- name: Ensure Matrix SSL-related files are deleted
|
||||
ansible.builtin.file:
|
||||
path: "{{ matrix_base_data_path }}/ssl"
|
||||
state: absent
|
||||
|
||||
- name: Ensure matrix SSL-related systemd timers and services are gone
|
||||
- name: Ensure Matrix SSL-related systemd timers and services are gone
|
||||
ansible.builtin.file:
|
||||
path: "{{ devture_systemd_docker_base_systemd_path }}/{{ item }}"
|
||||
state: absent
|
||||
|
||||
Loading…
Reference in New Issue
Block a user