Now that shortcut commands for the "just" program are displayed along with the existing "installation command", this commit replaces "run the installation command" with "run the playbook with tags" in order to prevent misunderstanding and confusion. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3842/head
| @@ -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 | ## Installing | ||||
| Now that you've [prepared the bot account and room](#account-and-room-preparation), [configured the playbook](#adjusting-the-playbook-configuration), and potentially [adjusted your DNS records](#adjusting-dns-records), you can run the [installation](installing.md) command: | |||||
| Now that you've [prepared the bot account and room](#account-and-room-preparation), [configured the playbook](#adjusting-the-playbook-configuration), and potentially [adjusted your DNS records](#adjusting-dns-records), you can run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -16,7 +16,7 @@ matrix_appservice_double_puppet_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -49,7 +49,7 @@ matrix_appservice_draupnir_for_all_master_control_room_alias: "ALIAS_FROM_STEP_2 | |||||
| ### 4. Installing | ### 4. Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -71,7 +71,7 @@ Check the [backup_borg role](https://github.com/mother-of-all-self-hosting/ansib | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -376,7 +376,7 @@ matrix_bot_baibot_config_initial_global_config_handler_image_generation: null | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -56,7 +56,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -56,7 +56,7 @@ You will need to get tokens for ChatGPT. | |||||
| ## 4. Installing | ## 4. Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -115,7 +115,7 @@ That is all you need to do due to that Draupnir can complete migration on its ow | |||||
| ## 6. Installing | ## 6. Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -219,7 +219,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -48,7 +48,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -32,7 +32,7 @@ The bot account will be created automatically. | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -27,7 +27,7 @@ matrix_bot_matrix_reminder_bot_reminders_timezone: Europe/London | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -49,7 +49,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -117,7 +117,7 @@ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_ban_lists: [] | |||||
| ## 7. Installing | ## 7. Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -30,7 +30,7 @@ matrix_appservice_discord_bot_token: "YOUR DISCORD APP BOT TOKEN" | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -62,7 +62,7 @@ matrix_appservice_irc_ircService_servers: | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -33,7 +33,7 @@ Take a look at: | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -65,7 +65,7 @@ Other configuration options are available via the `matrix_appservice_slack_confi | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -26,7 +26,7 @@ matrix_appservice_webhooks_api_secret: '<your_secret>' | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -35,7 +35,7 @@ You may wish to look at `roles/custom/matrix-bridge-beeper-linkedin/templates/co | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -14,7 +14,7 @@ matrix_go_skype_bridge_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -49,7 +49,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -33,7 +33,7 @@ matrix_sms_bridge_provider_android_truststore_password: 123 | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -42,7 +42,7 @@ Take a look at: | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -55,7 +55,7 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-facebook/templates/c | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -20,7 +20,7 @@ matrix_mautrix_gmessages_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -20,7 +20,7 @@ matrix_mautrix_googlechat_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -22,7 +22,7 @@ matrix_mautrix_hangouts_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -42,7 +42,7 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-instagram/templates/ | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -68,7 +68,7 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-meta-instagram/templ | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -82,7 +82,7 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-meta-messenger/templ | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -68,7 +68,7 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-signal/templates/con | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -44,7 +44,7 @@ Take a look at: | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -22,7 +22,7 @@ matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -22,7 +22,7 @@ matrix_mautrix_twitter_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -36,7 +36,7 @@ If you want to activate the relay bot in a room, send `!wa set-relay`. To deacti | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -41,7 +41,7 @@ By default, you will need to create a CNAME record for `wsproxy`. See [Configuri | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -18,7 +18,7 @@ matrix_mx_puppet_discord_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -14,7 +14,7 @@ matrix_mx_puppet_groupme_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -14,7 +14,7 @@ matrix_mx_puppet_instagram_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -23,7 +23,7 @@ matrix_mx_puppet_slack_oauth_client_secret: "<SLACK_APP_CLIENT_SECRET>" | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -14,7 +14,7 @@ matrix_mx_puppet_steam_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -25,7 +25,7 @@ matrix_mx_puppet_twitter_environment: '' | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -49,7 +49,7 @@ You will also need to add several DNS records so that Postmoogle can send emails | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -14,7 +14,7 @@ matrix_wechat_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -63,7 +63,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -42,7 +42,7 @@ If you've adjusted `matrix_client_cinny_hostname`, you will need to adjust your | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -71,7 +71,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -39,7 +39,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -69,7 +69,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -34,7 +34,7 @@ Alternatively, **if there is no pre-defined variable** for a Dendrite setting yo | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -69,7 +69,7 @@ By default, you will need to create a CNAME record for `dimension`. See [Configu | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -25,7 +25,7 @@ matrix_dynamic_dns_domain_configurations: | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -44,7 +44,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -269,7 +269,7 @@ jitsi_disable_gravatar: false | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -131,7 +131,7 @@ matrix_ma1sd_configuration_extension_yaml: | | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -288,7 +288,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN | |||||
| ## Installing | ## Installing | ||||
| 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: | |||||
| Now that you've [adjusted the playbook configuration](#adjusting-the-playbook-configuration) and [your DNS records](#adjusting-dns-records), you can run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -34,7 +34,7 @@ matrix_ldap_registration_proxy_systemd_wanted_services_list_custom: | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -52,7 +52,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -93,7 +93,7 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-SERVICENAME/template | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -50,7 +50,7 @@ By default, you will need to create a CNAME record for `ntfy`. See [Configuring | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -18,7 +18,7 @@ The default configuration should suffice. For advanced configuration, you can ov | |||||
| ## 2. Installing | ## 2. Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -29,7 +29,7 @@ Refer to the table below for additional configuration variables and their defaul | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -55,7 +55,7 @@ By default, you will need to create a CNAME record for `stats`. See [Configuring | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -22,7 +22,7 @@ matrix_prometheus_nginxlog_exporter_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -12,7 +12,7 @@ prometheus_postgres_exporter_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -51,7 +51,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -26,7 +26,7 @@ matrix_synapse_password_config_localdb_enabled: false | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -30,7 +30,7 @@ There are a few options for handling this: | |||||
| ### Re-running the playbook | ### Re-running the playbook | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -25,7 +25,7 @@ matrix_synapse_password_config_localdb_enabled: false | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -39,7 +39,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -77,7 +77,7 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -48,7 +48,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| ## Usage | ## Usage | ||||
| @@ -18,7 +18,7 @@ matrix_synapse_auto_compressor_enabled: true | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -50,7 +50,7 @@ If you've decided to use the default hostname, you won't need to do any extra DN | |||||
| ## Installing | ## Installing | ||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: | |||||
| After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -90,7 +90,7 @@ This will instruct UVS to verify the OpenID token against any domain given in a | |||||
| ## Installing | ## Installing | ||||
| After these variables have been set, run the [installation](installing.md) command to restart UVS: | |||||
| After these variables have been set, run the playbook with [playbook tags](playbook-tags.md) as below to restart UVS: | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-matrix-user-verification-service,start | ansible-playbook -i inventory/hosts setup.yml --tags=setup-matrix-user-verification-service,start | ||||
| @@ -269,7 +269,7 @@ matrix_server_fqn_element: "element.example.com" | |||||
| matrix_server_fqn_etherpad: "etherpad.example.com" | matrix_server_fqn_etherpad: "etherpad.example.com" | ||||
| ``` | ``` | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||
| @@ -112,7 +112,7 @@ For Dendrite: | |||||
| matrix_dendrite_client_api_registration_disabled: false | matrix_dendrite_client_api_registration_disabled: false | ||||
| ``` | ``` | ||||
| After configuring the playbook, run the [installation](installing.md) command: | |||||
| After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: | |||||
| <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | <!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. --> | ||||
| ```sh | ```sh | ||||