Document Conduit installation
Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/2076
This commit is contained in:
parent
35c5c23a3e
commit
ce8e9be6a8
58
docs/configuring-playbook-conduit.md
Normal file
58
docs/configuring-playbook-conduit.md
Normal file
|
@ -0,0 +1,58 @@
|
||||||
|
# Configuring Conduit (optional)
|
||||||
|
|
||||||
|
By default, this playbook configures the [Synapse](https://github.com/matrix-org/synapse) Matrix server, but you can also use [Conduit](https://conduit.rs).
|
||||||
|
|
||||||
|
**NOTES**:
|
||||||
|
|
||||||
|
- **You can't switch an existing Matrix server's implementation** (e.g. Synapse -> Conduit). Proceed below only if you're OK with losing data or you're dealing with a server on a new domain name, which hasn't participated in the Matrix federation yet.
|
||||||
|
|
||||||
|
- **homeserver implementations other than Synapse may not be fully functional**. The playbook may also not assist you in an optimal way (like it does with Synapse). Make yourself familiar with the downsides before proceeding
|
||||||
|
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
To use Conduit, you **generally** need the following additional `vars.yml` configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
matrix_homeserver_implementation: conduit
|
||||||
|
```
|
||||||
|
|
||||||
|
However, since Conduit is difficult (see [famedly/conduit#276](https://gitlab.com/famedly/conduit/-/issues/276) and [famedly/conduit#354](https://gitlab.com/famedly/conduit/-/merge_requests/354)) when it comes to creating the first user account and does not support [registering users](registering-users.md) (via the command line or via the playbook) like Synapse and Dendrite do, we recommend the following flow:
|
||||||
|
|
||||||
|
1. Add `matrix_conduit_allow_registration: true` to your `vars.yml` the first time around, temporarily
|
||||||
|
2. Run the playbook (`ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start` - see [Installing](installing.md))
|
||||||
|
3. Create your first user via Element or any other client which supports creating users
|
||||||
|
4. Get rid of `matrix_conduit_allow_registration: true` from your `vars.yml`
|
||||||
|
5. Run the playbook again (`ansible-playbook -i inventory/hosts setup.yml --tags=setup-conduit,start` would be enough this time)
|
||||||
|
6. You can now use your server safely. Additional users can be created by messaging the internal Conduit bot
|
||||||
|
|
||||||
|
|
||||||
|
## Configuring bridges / appservices
|
||||||
|
|
||||||
|
Automatic appservice setup is currently unsupported when using conduit. After setting up the service as usual you may notice that it is unable to start.
|
||||||
|
|
||||||
|
You will have to manually register appservices using the the [register-appservice](https://gitlab.com/famedly/conduit/-/blob/next/APPSERVICES.md) command.
|
||||||
|
|
||||||
|
Find the `registration.yaml` in the `/matrix` directory, for example `/matrix/mautrix-signal/bridge/registration.yaml`, then pass the content to conduit:
|
||||||
|
|
||||||
|
|
||||||
|
@conduit:your.server.name: register-appservice
|
||||||
|
```
|
||||||
|
as_token: <token>
|
||||||
|
de.sorunome.msc2409.push_ephemeral: true
|
||||||
|
hs_token: <token>
|
||||||
|
id: signal
|
||||||
|
namespaces:
|
||||||
|
aliases:
|
||||||
|
- exclusive: true
|
||||||
|
regex: ^#signal_.+:example\.org$
|
||||||
|
users:
|
||||||
|
- exclusive: true
|
||||||
|
regex: ^@signal_.+:example\.org$
|
||||||
|
- exclusive: true
|
||||||
|
regex: ^@signalbot:example\.org$
|
||||||
|
rate_limited: false
|
||||||
|
sender_localpart: _bot_signalbot
|
||||||
|
url: http://matrix-mautrix-signal:29328
|
||||||
|
```
|
||||||
|
|
|
@ -42,7 +42,10 @@ When you're done with all the configuration you'd like to do, continue with [Ins
|
||||||
|
|
||||||
### Core service adjustments
|
### Core service adjustments
|
||||||
|
|
||||||
- [Configuring Synapse](configuring-playbook-synapse.md) (optional)
|
- Homeserver configuration:
|
||||||
|
- [Configuring Synapse](configuring-playbook-synapse.md), if you're going with the default/recommended homeserver implementation (optional)
|
||||||
|
|
||||||
|
- [Configuring Conduit](configuring-playbook-conduit.md), if you've switched to the [Conduit](https://conduit.rs) homeserver implementation (optional)
|
||||||
|
|
||||||
- [Configuring Element](configuring-playbook-client-element.md) (optional)
|
- [Configuring Element](configuring-playbook-client-element.md) (optional)
|
||||||
|
|
||||||
|
|
|
@ -12,7 +12,9 @@
|
||||||
matrix_domain: YOUR_BARE_DOMAIN_NAME_HERE
|
matrix_domain: YOUR_BARE_DOMAIN_NAME_HERE
|
||||||
|
|
||||||
# The Matrix homeserver software to install.
|
# The Matrix homeserver software to install.
|
||||||
# See `roles/matrix-base/defaults/main.yml` for valid options.
|
# See:
|
||||||
|
# - `roles/matrix-base/defaults/main.yml` for valid options
|
||||||
|
# - the `docs/configuring-playbook-IMPLEMENTATION_NAME.md` documentation page, if one is available for your implementation choice
|
||||||
matrix_homeserver_implementation: synapse
|
matrix_homeserver_implementation: synapse
|
||||||
|
|
||||||
# A secret used as a base, for generating various other secrets.
|
# A secret used as a base, for generating various other secrets.
|
||||||
|
|
Loading…
Reference in a new issue