From 07d9a346aa1917dd950b64720ae059f0ecdd1e45 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 11 Jan 2025 01:57:27 +0900 Subject: [PATCH] Update docs for Conduit and Dendrite: use the common descriptions for introductions - Edit the instruction for adjusting the configuration Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-conduit.md | 8 ++++++-- docs/configuring-playbook-dendrite.md | 8 ++++++-- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/configuring-playbook-conduit.md b/docs/configuring-playbook-conduit.md index e30742438..12e93dcc5 100644 --- a/docs/configuring-playbook-conduit.md +++ b/docs/configuring-playbook-conduit.md @@ -1,6 +1,10 @@ # Configuring Conduit (optional) -By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Conduit](https://conduit.rs). +The playbook can install and configure the [Conduit](https://conduit.rs) Matrix server for you. + +See the project's [documentation](https://docs.conduit.rs/) to learn what it does and why it might be useful to you. + +By default, the playbook installs [Synapse](https://github.com/element-hq/synapse) as it's the only full-featured Matrix server at the moment. If that's okay, you can skip this document. ⚠️ **Warnings**: @@ -10,7 +14,7 @@ By default, this playbook configures the [Synapse](https://github.com/element-hq ## Adjusting the playbook configuration -To use Conduit, you **generally** need to add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: +To use Conduit, you **generally** need to adjust the `matrix_homeserver_implementation: synapse` configuration on your `inventory/host_vars/matrix.example.com/vars.yml` file as below: ```yaml matrix_homeserver_implementation: conduit diff --git a/docs/configuring-playbook-dendrite.md b/docs/configuring-playbook-dendrite.md index 248a0ac3d..29fbaa6c7 100644 --- a/docs/configuring-playbook-dendrite.md +++ b/docs/configuring-playbook-dendrite.md @@ -1,6 +1,10 @@ # Configuring Dendrite (optional) -By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Dendrite](https://github.com/element-hq/dendrite). +The playbook can install and configure the [Dendrite](https://github.com/element-hq/dendrite) Matrix server for you. + +See the project's [documentation](https://element-hq.github.io/dendrite/) to learn what it does and why it might be useful to you. + +By default, the playbook installs [Synapse](https://github.com/element-hq/synapse) as it's the only full-featured Matrix server at the moment. If that's okay, you can skip this document. ⚠️ **Warnings**: @@ -10,7 +14,7 @@ By default, this playbook configures the [Synapse](https://github.com/element-hq ## Adjusting the playbook configuration -To use Dendrite, you **generally** need to add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: +To use Dendrite, you **generally** need to adjust the `matrix_homeserver_implementation: synapse` configuration on your `inventory/host_vars/matrix.example.com/vars.yml` file as below: ```yaml matrix_homeserver_implementation: dendrite