Add minor updates to documentationpull/3626/head
| @@ -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. | 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. | 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 <sitename>`. You will then be invited into a moderation room. | Then, register a site by typing: `register <sitename>`. You will then be invited into a moderation room. | ||||
| Now you are good to go and can include the comment section on your website! | 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! | **Careful**: To really make use of self-hosting you need change a few things in comparison to the official docs! | ||||
| @@ -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): | 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 | ```yaml | ||||
| matrix_server_fqn_cinny: "app.{{ matrix_domain }}" | |||||
| matrix_server_fqn_cinny: "app.{{ matrix_domain }}" | |||||
| ``` | ``` | ||||
| ## Adjusting the playbook configuration | ## Adjusting the playbook configuration | ||||
| @@ -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): | 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 | ```yaml | ||||
| matrix_server_fqn_hydrogen: "helium.{{ matrix_domain }}" | |||||
| matrix_server_fqn_hydrogen: "helium.{{ matrix_domain }}" | |||||
| ``` | ``` | ||||
| ## Adjusting the playbook configuration | ## Adjusting the playbook configuration | ||||
| @@ -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): | 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 | ```yaml | ||||
| matrix_server_fqn_schildichat: "sc.{{ matrix_domain }}" | |||||
| matrix_server_fqn_schildichat: "sc.{{ matrix_domain }}" | |||||
| ``` | ``` | ||||
| ## Adjusting the playbook configuration | ## Adjusting the playbook configuration | ||||
| @@ -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. | # 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 | # 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. | **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. | ||||