diff --git a/CHANGELOG.md b/CHANGELOG.md index e164369d3..139f42814 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +# 2025-11-22 + +## Matrix.to support + +The playbook now supports [Matrix.to](https://github.com/matrix-org/matrix.to) — a simple URL redirection service which powers [matrix.to](https://matrix.to). + +To learn more, see our [Setting up Matrix.to](docs/configuring-playbook-matrixto.md) documentation page. + # 2025-11-09 ## matrix-appservice-webhooks has been removed from the playbook diff --git a/README.md b/README.md index 4fa5954a7..8e90f577d 100644 --- a/README.md +++ b/README.md @@ -179,6 +179,7 @@ Various services that don't fit any other categories. | [synapse_auto_accept_invite](https://github.com/matrix-org/synapse-auto-accept-invite) | ❌ | Synapse module to automatically accept invites | [Link](docs/configuring-playbook-synapse-auto-accept-invite.md) | | [synapse_auto_compressor](https://github.com/matrix-org/rust-synapse-compress-state/#automated-tool-synapse_auto_compressor) | ❌ | Cli tool that automatically compresses `state_groups` database table in background | [Link](docs/configuring-playbook-synapse-auto-compressor.md) | | [Matrix Corporal](https://github.com/devture/matrix-corporal) (advanced) | ❌ | Reconciliator and gateway for a managed Matrix server | [Link](docs/configuring-playbook-matrix-corporal.md) | +| [Matrix.to](https://github.com/matrix-org/matrix.to) | ❌ | Simple URL redirection service for the Matrix ecosystem | [Link](docs/configuring-playbook-matrixto.md) | | [Etherpad](https://etherpad.org) | ❌ | Open source collaborative text editor | [Link](docs/configuring-playbook-etherpad.md) | | [Jitsi](https://jitsi.org/) | ❌ | Open source video-conferencing platform | [Link](docs/configuring-playbook-jitsi.md) | | [Cactus Comments](https://cactus.chat) | ❌ | Federated comment system built on Matrix | [Link](docs/configuring-playbook-cactus-comments.md) | diff --git a/docs/configuring-playbook-matrixto.md b/docs/configuring-playbook-matrixto.md new file mode 100644 index 000000000..f8cc60e47 --- /dev/null +++ b/docs/configuring-playbook-matrixto.md @@ -0,0 +1,68 @@ + + +# Setting up Matrix.to (optional) + +The playbook can install and configure the [Matrix.to](https://github.com/matrix-org/matrix.to) URL redirection service for you. + +See the project's [documentation](https://github.com/matrix-org/matrix.to/blob/main/README.md) to learn what it does and why it might be useful to you. + +## Adjusting DNS records + +By default, this playbook installs Matrix.to on the `mt.` subdomain (`mt.example.com`) and requires you to create a CNAME record for `mt`, which targets `matrix.example.com`. + +When setting, replace `example.com` with your own. + +## Adjusting the playbook configuration + +To enable Matrix.to, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: + +```yaml +matrix_matrixto_enabled: true +``` + +### Adjusting the Matrix.to URL (optional) + +By tweaking the `matrix_matrixto_hostname` variable, you can easily make the service available at a **different hostname** than the default one. + +Example additional configuration for your `vars.yml` file: + +```yaml +# Change the default hostname +matrix_matrixto_hostname: t.example.com +``` + +After changing the domain, **you may need to adjust your DNS** records to point the Matrix.to domain to the Matrix server. + +### Extending the configuration + +There are some additional things you may wish to configure about the server. + +Take a look at: + +- `roles/custom/matrix-matrixto/defaults/main.yml` for some variables that you can customize via your `vars.yml` file + +## Installing + +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all` + +`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too. + +## Usage + +Refer to the project's [documentation](https://github.com/matrix-org/matrix.to/blob/main/README.md) for available parameters, etc. + +## Troubleshooting + +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-matrixto`. diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 85127a0ac..31fd9e63d 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -247,6 +247,8 @@ Various services that don't fit any other categories. - [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (advanced) +- [Setting up Matrix.to](configuring-playbook-matrixto.md) + - [Setting up Etherpad](configuring-playbook-etherpad.md) - [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md)