From e8c61b0a3c22d546abe07dc7c7e1941bb59a495a Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 21 Oct 2024 05:42:21 +0900 Subject: [PATCH] Update lines for installing instruction: add anchor link to "adjusting DNS records" header Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-alertmanager-receiver.md | 2 +- docs/configuring-playbook-bot-buscarron.md | 2 +- docs/configuring-playbook-bot-go-neb.md | 2 +- docs/configuring-playbook-bot-honoroit.md | 2 +- docs/configuring-playbook-bot-maubot.md | 2 +- docs/configuring-playbook-bridge-heisenbridge.md | 2 +- docs/configuring-playbook-bridge-mautrix-wsproxy.md | 2 +- docs/configuring-playbook-cactus-comments.md | 2 +- docs/configuring-playbook-client-cinny.md | 2 +- docs/configuring-playbook-client-element.md | 2 +- docs/configuring-playbook-client-hydrogen.md | 2 +- docs/configuring-playbook-client-schildichat.md | 2 +- docs/configuring-playbook-dimension.md | 2 +- docs/configuring-playbook-etherpad.md | 2 +- docs/configuring-playbook-jitsi.md | 2 +- docs/configuring-playbook-matrix-authentication-service.md | 2 +- docs/configuring-playbook-matrix-registration.md | 2 +- docs/configuring-playbook-ntfy.md | 2 +- docs/configuring-playbook-prometheus-grafana.md | 2 +- docs/configuring-playbook-rageshake.md | 2 +- docs/configuring-playbook-sliding-sync-proxy.md | 2 +- docs/configuring-playbook-synapse-admin.md | 3 +-- docs/configuring-playbook-synapse-usage-exporter.md | 2 +- 23 files changed, 23 insertions(+), 24 deletions(-) diff --git a/docs/configuring-playbook-alertmanager-receiver.md b/docs/configuring-playbook-alertmanager-receiver.md index 566cfc550..1de72ee21 100644 --- a/docs/configuring-playbook-alertmanager-receiver.md +++ b/docs/configuring-playbook-alertmanager-receiver.md @@ -76,7 +76,7 @@ Steps 3 and 4 need to be done for each new room you'd like the bot to deliver al ## Installing -Now that you've [prepared the bot account and room](#account-and-room-preparation) and have [configured the playbook](#configuration), you can run the [installation](installing.md) command: `just install-all` +Now that you've [prepared the bot account and room](#account-and-room-preparation), [configured the playbook](#configuration), and potentially [adjusted your DNS records](#adjusting-dns-records), you can run the [installation](installing.md) command: `just install-all` Then, you can proceed to [Usage](#usage). diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md index 4c81cebb9..20cd40c9f 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -56,7 +56,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -After configuring the playbook, run the [installation](installing.md) command: +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start diff --git a/docs/configuring-playbook-bot-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index 72334f1a5..e3316a54b 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -217,7 +217,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -After potentially [adjusting DNS records](#adjusting-dns-records) and configuring the playbook, run the [installation](installing.md) command again: +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: ``` ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start diff --git a/docs/configuring-playbook-bot-honoroit.md b/docs/configuring-playbook-bot-honoroit.md index 717791573..29680cb04 100644 --- a/docs/configuring-playbook-bot-honoroit.md +++ b/docs/configuring-playbook-bot-honoroit.md @@ -48,7 +48,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -After configuring the playbook, run the [installation](installing.md) command: +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start diff --git a/docs/configuring-playbook-bot-maubot.md b/docs/configuring-playbook-bot-maubot.md index cd866f6fd..8a59ac919 100644 --- a/docs/configuring-playbook-bot-maubot.md +++ b/docs/configuring-playbook-bot-maubot.md @@ -51,7 +51,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` **Notes**: diff --git a/docs/configuring-playbook-bridge-heisenbridge.md b/docs/configuring-playbook-bridge-heisenbridge.md index f09e9add3..9a96330ff 100644 --- a/docs/configuring-playbook-bridge-heisenbridge.md +++ b/docs/configuring-playbook-bridge-heisenbridge.md @@ -49,7 +49,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-wsproxy.md b/docs/configuring-playbook-bridge-mautrix-wsproxy.md index 48e3a9198..14af101dc 100644 --- a/docs/configuring-playbook-bridge-mautrix-wsproxy.md +++ b/docs/configuring-playbook-bridge-mautrix-wsproxy.md @@ -41,7 +41,7 @@ By default, you will need to create a CNAME record for `wsproxy`. See [Configuri ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` ## Usage diff --git a/docs/configuring-playbook-cactus-comments.md b/docs/configuring-playbook-cactus-comments.md index 735bf1edd..0607e288e 100644 --- a/docs/configuring-playbook-cactus-comments.md +++ b/docs/configuring-playbook-cactus-comments.md @@ -63,7 +63,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` ## Usage diff --git a/docs/configuring-playbook-client-cinny.md b/docs/configuring-playbook-client-cinny.md index 680baa1d8..9925c836f 100644 --- a/docs/configuring-playbook-client-cinny.md +++ b/docs/configuring-playbook-client-cinny.md @@ -39,4 +39,4 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` diff --git a/docs/configuring-playbook-client-element.md b/docs/configuring-playbook-client-element.md index 159072cca..c0f7c348c 100644 --- a/docs/configuring-playbook-client-element.md +++ b/docs/configuring-playbook-client-element.md @@ -66,4 +66,4 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` diff --git a/docs/configuring-playbook-client-hydrogen.md b/docs/configuring-playbook-client-hydrogen.md index 6ad08c770..7e3aab465 100644 --- a/docs/configuring-playbook-client-hydrogen.md +++ b/docs/configuring-playbook-client-hydrogen.md @@ -39,4 +39,4 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` diff --git a/docs/configuring-playbook-client-schildichat.md b/docs/configuring-playbook-client-schildichat.md index 6f220ad65..0cf640f6f 100644 --- a/docs/configuring-playbook-client-schildichat.md +++ b/docs/configuring-playbook-client-schildichat.md @@ -65,4 +65,4 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` diff --git a/docs/configuring-playbook-dimension.md b/docs/configuring-playbook-dimension.md index 93f2c7d51..aca5fdb83 100644 --- a/docs/configuring-playbook-dimension.md +++ b/docs/configuring-playbook-dimension.md @@ -73,7 +73,7 @@ By default, you will need to create a CNAME record for `dimension`. See [Configu ## Installing -After these variables have been set and you have potentially [adjusted your DNS records](#adjusting-dns-records), please run the following command to re-run setup and to restart Dimension: +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: ``` ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start diff --git a/docs/configuring-playbook-etherpad.md b/docs/configuring-playbook-etherpad.md index 18e37c5f4..8a734a739 100644 --- a/docs/configuring-playbook-etherpad.md +++ b/docs/configuring-playbook-etherpad.md @@ -44,7 +44,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` ## Usage diff --git a/docs/configuring-playbook-jitsi.md b/docs/configuring-playbook-jitsi.md index 3398bf3c1..ac39b3b88 100644 --- a/docs/configuring-playbook-jitsi.md +++ b/docs/configuring-playbook-jitsi.md @@ -284,7 +284,7 @@ Besides metadata, this includes the Matrix user_id and possibly the room identif ## Installing -After configuring the playbook, run the [installation](installing.md) command: +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: ``` ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start diff --git a/docs/configuring-playbook-matrix-authentication-service.md b/docs/configuring-playbook-matrix-authentication-service.md index b0a0a8d9c..8c2631d40 100644 --- a/docs/configuring-playbook-matrix-authentication-service.md +++ b/docs/configuring-playbook-matrix-authentication-service.md @@ -269,7 +269,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -Now that you've [adjusted the playbook configuration](#adjusting-the-playbook-configuration), you can run the [installation](installing.md) command: `just install-all` +Now that you've [adjusted the playbook configuration](#adjusting-the-playbook-configuration) and [your DNS records](#adjusting-dns-records), you can run the [installation](installing.md) command: `just install-all` If you're in the process of migrating an existing Synapse homeserver to MAS, you should now follow the rest of the steps in the [Migrating an existing homeserver to Matrix Authentication Service](#migrating-an-existing-homeserver-to-matrix-authentication-service) guide. diff --git a/docs/configuring-playbook-matrix-registration.md b/docs/configuring-playbook-matrix-registration.md index 974789525..2b89a3eca 100644 --- a/docs/configuring-playbook-matrix-registration.md +++ b/docs/configuring-playbook-matrix-registration.md @@ -52,7 +52,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -After configuring the playbook, run the [installation](installing.md) command: +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: ``` ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start diff --git a/docs/configuring-playbook-ntfy.md b/docs/configuring-playbook-ntfy.md index aedd51b81..48a51da48 100644 --- a/docs/configuring-playbook-ntfy.md +++ b/docs/configuring-playbook-ntfy.md @@ -50,7 +50,7 @@ By default, you will need to create a CNAME record for `ntfy`. See [Configuring ## Installing -After configuring the playbook, run the [installation](installing.md) command: +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: ``` ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 3b0426b07..c92fd1ede 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -55,7 +55,7 @@ By default, you will need to create a CNAME record for `stats`. See [Configuring ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` ## What does it do? diff --git a/docs/configuring-playbook-rageshake.md b/docs/configuring-playbook-rageshake.md index a9f7f63b6..154949499 100644 --- a/docs/configuring-playbook-rageshake.md +++ b/docs/configuring-playbook-rageshake.md @@ -51,7 +51,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -After configuring the playbook, run the [installation](installing.md) command: +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: ``` ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start diff --git a/docs/configuring-playbook-sliding-sync-proxy.md b/docs/configuring-playbook-sliding-sync-proxy.md index 4193547f8..b35fe25ba 100644 --- a/docs/configuring-playbook-sliding-sync-proxy.md +++ b/docs/configuring-playbook-sliding-sync-proxy.md @@ -44,7 +44,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -After potentially [adjusting DNS records](#adjusting-dns-records) and configuring the playbook, run the [installation](installing.md) command again: `just install-all`. +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all`. ### External databases diff --git a/docs/configuring-playbook-synapse-admin.md b/docs/configuring-playbook-synapse-admin.md index 497c0a709..39d9d3df4 100644 --- a/docs/configuring-playbook-synapse-admin.md +++ b/docs/configuring-playbook-synapse-admin.md @@ -48,8 +48,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` - +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: ## Usage diff --git a/docs/configuring-playbook-synapse-usage-exporter.md b/docs/configuring-playbook-synapse-usage-exporter.md index 0c9e19880..8a472f345 100644 --- a/docs/configuring-playbook-synapse-usage-exporter.md +++ b/docs/configuring-playbook-synapse-usage-exporter.md @@ -50,4 +50,4 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`