From bf8bbdd5ba41032935952f6f7a587a6de4ebea7d Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 15 Oct 2024 18:33:19 +0900 Subject: [PATCH 1/3] Remove whitespace characters from the comment block Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-client-cinny.md | 2 +- docs/configuring-playbook-client-hydrogen.md | 2 +- docs/configuring-playbook-client-schildichat.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuring-playbook-client-cinny.md b/docs/configuring-playbook-client-cinny.md index a3db9bc4c..bcecff2d7 100644 --- a/docs/configuring-playbook-client-cinny.md +++ b/docs/configuring-playbook-client-cinny.md @@ -13,7 +13,7 @@ for `cinny`. See [Configuring DNS](configuring-dns.md). If you would like to use a different domain, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (changing it to use your preferred domain): ```yaml - matrix_server_fqn_cinny: "app.{{ matrix_domain }}" +matrix_server_fqn_cinny: "app.{{ matrix_domain }}" ``` ## Adjusting the playbook configuration diff --git a/docs/configuring-playbook-client-hydrogen.md b/docs/configuring-playbook-client-hydrogen.md index c840efad9..28ddb900a 100644 --- a/docs/configuring-playbook-client-hydrogen.md +++ b/docs/configuring-playbook-client-hydrogen.md @@ -13,7 +13,7 @@ for `hydrogen`. See [Configuring DNS](configuring-dns.md). If you would like to use a different domain, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (changing it to use your preferred domain): ```yaml - matrix_server_fqn_hydrogen: "helium.{{ matrix_domain }}" +matrix_server_fqn_hydrogen: "helium.{{ matrix_domain }}" ``` ## Adjusting the playbook configuration diff --git a/docs/configuring-playbook-client-schildichat.md b/docs/configuring-playbook-client-schildichat.md index 856e71c13..81fe411d1 100644 --- a/docs/configuring-playbook-client-schildichat.md +++ b/docs/configuring-playbook-client-schildichat.md @@ -15,7 +15,7 @@ for `schildichat`. See [Configuring DNS](configuring-dns.md). If you would like to use a different domain, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file (changing it to use your preferred domain): ```yaml - matrix_server_fqn_schildichat: "sc.{{ matrix_domain }}" +matrix_server_fqn_schildichat: "sc.{{ matrix_domain }}" ``` ## Adjusting the playbook configuration From 0b688eb9491a64f1a0a34e012c68a8158b974109 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 17 Oct 2024 18:45:47 +0900 Subject: [PATCH 2/3] Update docs/configuring-playbook-external-postgres.md: minor changes Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-external-postgres.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/configuring-playbook-external-postgres.md b/docs/configuring-playbook-external-postgres.md index 2dc591b3a..b8c8f8eb9 100644 --- a/docs/configuring-playbook-external-postgres.md +++ b/docs/configuring-playbook-external-postgres.md @@ -17,11 +17,10 @@ matrix_synapse_database_database: "your-postgres-server-database-name" # Rewire any other service (each `matrix-*` role) you may wish to use to use your external Postgres server. # Each service expects to have its own dedicated database on the Postgres server -# and uses its own variable names (see `roles/custom/matrix-*/defaults/main.yml) for configuring Postgres connectivity. +# and uses its own variable names (see `roles/custom/matrix-*/defaults/main.yml`) for configuring Postgres connectivity. ``` -The database (as specified in `matrix_synapse_database_database`) must exist and be accessible with the given credentials. -It must be empty or contain a valid Synapse database. If empty, Synapse would populate it the first time it runs. +The database (as specified in `matrix_synapse_database_database`) must exist and be accessible with the given credentials. It must be empty or contain a valid Synapse database. If empty, Synapse would populate it the first time it runs. **Note**: the external server that you specify in `matrix_synapse_database_host` must be accessible from within the `matrix-synapse` Docker container (and possibly other containers too). This means that it either needs to be a publicly accessible hostname or that it's a hostname on the same Docker network where all containers installed by this playbook run (a network called `matrix` by default). Using a local PostgreSQL instance on the host (running on the same machine, but not in a container) is not possible. From 0eb53a0e77edfef34c11565ab6f0d0df2568ee3f Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 11 Oct 2024 04:01:07 +0900 Subject: [PATCH 3/3] Update docs/configuring-playbook-cactus-comments.md: add line breaks Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-cactus-comments.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/configuring-playbook-cactus-comments.md b/docs/configuring-playbook-cactus-comments.md index 263406242..98ec896e8 100644 --- a/docs/configuring-playbook-cactus-comments.md +++ b/docs/configuring-playbook-cactus-comments.md @@ -53,7 +53,9 @@ After configuring the playbook, run the [installation](installing.md) command: ` Upon starting Cactus Comments, a `bot.cactusbot` user account is created automatically. To get started, send a `help` message to the `@bot.cactusbot:your-homeserver.com` bot to confirm it's working. + Then, register a site by typing: `register `. You will then be invited into a moderation room. + Now you are good to go and can include the comment section on your website! **Careful**: To really make use of self-hosting you need change a few things in comparison to the official docs!