From 20c2aade3ec34bb6fd70fbad8c67653ae6c592b2 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 1 Dec 2024 16:42:30 +0900 Subject: [PATCH] Edit descriptions about installation of components (#3842) * Replace installation command shortcut for the "just" program with the most conservative raw ansible-playbook command This commit replaces installation command shortcut ("recipe") for the "just" program with the raw ansible-playbook command, so that the shortcut will be added to it later. The command is so conservative that failure of the command will mean something is clearly broken. Signed-off-by: Suguru Hirahara * Add comments about using setup-all instead of install-all Signed-off-by: Suguru Hirahara * Add description about shortcut command with the "just" program to the ansible-playbook command with "setup-all" and "start" tags It also explains difference between "just install-all" and "just setup-all" recipes. The explanation is based on docs/playbook-tags.md Signed-off-by: Suguru Hirahara * Update raw ansible-playbook command to have it do what "just install-all" or "just setup-all" does Since "just install-all" or "just setup-all" invokes "ensure-matrix-users-created" as well, it needs adding to the raw ansible-playbook command. Signed-off-by: Suguru Hirahara * Remove "ensure-matrix-users-created" from the raw ansible-playbook command which does not need it Also: update the "just" recipes accordingly. "just install-all" and "just setup-all" run "ensure-matrix-users-created" tag as well, therefore they need to be replaced with "run-tags" recipes to skip "ensure-matrix-users-created" Signed-off-by: Suguru Hirahara * Update docs/configuring-playbook-etherpad.md: add ensure-matrix-users-created to the raw ansible-playbook Signed-off-by: Suguru Hirahara * Add description about "ensure-matrix-users-created" and create a list with description about shortcut commands with "just" This commit also fixes list item capitalization and punctuation. Signed-off-by: Suguru Hirahara * Add notes bullet lists Signed-off-by: Suguru Hirahara * Update docs/configuring-playbook-matrix-corporal.md and docs/configuring-playbook-email2matrix.md: adopt common instructions Signed-off-by: Suguru Hirahara * Replace "run the installation command" with "run the playbook with tags" 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 * Add notes about changing passwords of users specified on vars.yml Signed-off-by: Suguru Hirahara * Update docs/configuring-playbook-synapse-admin.md: add the playbook command and just recipes Signed-off-by: Suguru Hirahara * Remove redundant blank lines Signed-off-by: Suguru Hirahara * Update docs/configuring-playbook-alertmanager-receiver.md: remove the direction to proceed to Usage Such a kind of direction is not used on other documentation, so it should be fine to just remove it. Signed-off-by: Suguru Hirahara * Update docs/importing-synapse-media-store.md: code block for ansible-playbook Signed-off-by: Suguru Hirahara --------- Signed-off-by: Suguru Hirahara Co-authored-by: Suguru Hirahara --- ...onfiguring-playbook-alertmanager-receiver.md | 14 ++++++++++++-- ...iguring-playbook-appservice-double-puppet.md | 15 ++++++++++++++- ...ring-playbook-appservice-draupnir-for-all.md | 12 ++++++++++-- docs/configuring-playbook-backup-borg.md | 7 ++++++- docs/configuring-playbook-bot-baibot.md | 12 ++++++++---- docs/configuring-playbook-bot-buscarron.md | 10 +++++++--- docs/configuring-playbook-bot-chatgpt.md | 12 ++++++++++-- docs/configuring-playbook-bot-draupnir.md | 14 ++++++++++++-- docs/configuring-playbook-bot-go-neb.md | 12 ++++++++++-- docs/configuring-playbook-bot-honoroit.md | 10 +++++++--- ...ring-playbook-bot-matrix-registration-bot.md | 17 ++++++++++++++++- ...figuring-playbook-bot-matrix-reminder-bot.md | 10 +++++++--- docs/configuring-playbook-bot-maubot.md | 15 +++++++++++++-- docs/configuring-playbook-bot-mjolnir.md | 14 ++++++++++++-- ...guring-playbook-bridge-appservice-discord.md | 13 +++++++++++-- ...onfiguring-playbook-bridge-appservice-irc.md | 15 ++++++++++++++- ...ring-playbook-bridge-appservice-kakaotalk.md | 13 +++++++++++-- ...figuring-playbook-bridge-appservice-slack.md | 13 +++++++++++-- ...uring-playbook-bridge-appservice-webhooks.md | 13 +++++++++++-- ...nfiguring-playbook-bridge-beeper-linkedin.md | 15 ++++++++++++++- ...nfiguring-playbook-bridge-go-skype-bridge.md | 15 ++++++++++++++- .../configuring-playbook-bridge-heisenbridge.md | 15 ++++++++++++++- ...iguring-playbook-bridge-matrix-bridge-sms.md | 15 ++++++++++++++- ...nfiguring-playbook-bridge-mautrix-discord.md | 13 +++++++++++-- ...figuring-playbook-bridge-mautrix-facebook.md | 15 ++++++++++++++- ...iguring-playbook-bridge-mautrix-gmessages.md | 15 ++++++++++++++- ...guring-playbook-bridge-mautrix-googlechat.md | 15 ++++++++++++++- ...figuring-playbook-bridge-mautrix-hangouts.md | 15 ++++++++++++++- ...iguring-playbook-bridge-mautrix-instagram.md | 15 ++++++++++++++- ...ng-playbook-bridge-mautrix-meta-instagram.md | 15 ++++++++++++++- ...ng-playbook-bridge-mautrix-meta-messenger.md | 15 ++++++++++++++- ...onfiguring-playbook-bridge-mautrix-signal.md | 15 ++++++++++++++- ...configuring-playbook-bridge-mautrix-slack.md | 13 +++++++++++-- ...figuring-playbook-bridge-mautrix-telegram.md | 15 ++++++++++++++- ...nfiguring-playbook-bridge-mautrix-twitter.md | 15 ++++++++++++++- ...figuring-playbook-bridge-mautrix-whatsapp.md | 15 ++++++++++++++- ...nfiguring-playbook-bridge-mautrix-wsproxy.md | 15 ++++++++++++++- ...iguring-playbook-bridge-mx-puppet-discord.md | 15 ++++++++++++++- ...iguring-playbook-bridge-mx-puppet-groupme.md | 15 ++++++++++++++- ...uring-playbook-bridge-mx-puppet-instagram.md | 15 ++++++++++++++- ...nfiguring-playbook-bridge-mx-puppet-slack.md | 13 +++++++++++-- ...nfiguring-playbook-bridge-mx-puppet-steam.md | 15 ++++++++++++++- ...iguring-playbook-bridge-mx-puppet-twitter.md | 15 ++++++++++++++- docs/configuring-playbook-bridge-postmoogle.md | 10 +++++++--- docs/configuring-playbook-bridge-wechat.md | 15 ++++++++++++++- docs/configuring-playbook-cactus-comments.md | 15 ++++++++++++++- docs/configuring-playbook-client-cinny.md | 11 ++++++++++- docs/configuring-playbook-client-element-web.md | 11 ++++++++++- docs/configuring-playbook-client-hydrogen.md | 11 ++++++++++- ...nfiguring-playbook-client-schildichat-web.md | 11 ++++++++++- docs/configuring-playbook-dendrite.md | 11 ++++++++++- docs/configuring-playbook-dimension.md | 10 ++++++++-- docs/configuring-playbook-dynamic-dns.md | 11 ++++++++++- docs/configuring-playbook-email2matrix.md | 14 ++++++++++++-- docs/configuring-playbook-etherpad.md | 17 ++++++++++++++++- docs/configuring-playbook-jitsi.md | 7 ++++++- docs/configuring-playbook-ma1sd.md | 11 ++++++++++- ...ng-playbook-matrix-authentication-service.md | 15 +++++++++++++-- docs/configuring-playbook-matrix-corporal.md | 10 +++++++++- ...g-playbook-matrix-ldap-registration-proxy.md | 11 ++++++++++- .../configuring-playbook-matrix-registration.md | 8 +++++++- docs/configuring-playbook-mautrix-bridges.md | 15 ++++++++++++++- docs/configuring-playbook-ntfy.md | 6 +++++- docs/configuring-playbook-pantalaimon.md | 11 ++++++++++- docs/configuring-playbook-postgres-backup.md | 7 ++++++- docs/configuring-playbook-prometheus-grafana.md | 11 ++++++++++- .../configuring-playbook-prometheus-nginxlog.md | 11 ++++++++++- .../configuring-playbook-prometheus-postgres.md | 11 ++++++++++- docs/configuring-playbook-rageshake.md | 6 +++++- docs/configuring-playbook-rest-auth.md | 11 ++++++++++- docs/configuring-playbook-riot-web.md | 11 ++++++++++- docs/configuring-playbook-shared-secret-auth.md | 11 ++++++++++- docs/configuring-playbook-sliding-sync-proxy.md | 11 ++++++++++- docs/configuring-playbook-sygnal.md | 6 +++++- docs/configuring-playbook-synapse-admin.md | 11 ++++++++++- ...figuring-playbook-synapse-auto-compressor.md | 6 +++++- ...nfiguring-playbook-synapse-usage-exporter.md | 11 ++++++++++- ...guring-playbook-user-verification-service.md | 6 +++++- docs/faq.md | 11 +++++++++-- docs/importing-synapse-media-store.md | 4 +++- docs/maintenance-and-troubleshooting.md | 3 +++ docs/maintenance-checking-services.md | 2 ++ docs/maintenance-migrating.md | 4 ++++ docs/maintenance-synapse.md | 2 ++ docs/registering-users.md | 14 ++++++++++++-- 85 files changed, 895 insertions(+), 111 deletions(-) diff --git a/docs/configuring-playbook-alertmanager-receiver.md b/docs/configuring-playbook-alertmanager-receiver.md index 9eca526bd..1507d3bd9 100644 --- a/docs/configuring-playbook-alertmanager-receiver.md +++ b/docs/configuring-playbook-alertmanager-receiver.md @@ -76,10 +76,20 @@ 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), [configured the playbook](#adjusting-the-playbook-configuration), and potentially [adjusted your DNS records](#adjusting-dns-records), 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](#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: -Then, you can proceed to [Usage](#usage). + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-appservice-double-puppet.md b/docs/configuring-playbook-appservice-double-puppet.md index b07662059..e4a3b3922 100644 --- a/docs/configuring-playbook-appservice-double-puppet.md +++ b/docs/configuring-playbook-appservice-double-puppet.md @@ -16,7 +16,20 @@ matrix_appservice_double_puppet_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-appservice-draupnir-for-all.md b/docs/configuring-playbook-appservice-draupnir-for-all.md index 37b7f86d3..be13c93a3 100644 --- a/docs/configuring-playbook-appservice-draupnir-for-all.md +++ b/docs/configuring-playbook-appservice-draupnir-for-all.md @@ -49,12 +49,20 @@ matrix_appservice_draupnir_for_all_master_control_room_alias: "ALIAS_FROM_STEP_2 ### 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-backup-borg.md b/docs/configuring-playbook-backup-borg.md index a7902d8de..07fc3080f 100644 --- a/docs/configuring-playbook-backup-borg.md +++ b/docs/configuring-playbook-backup-borg.md @@ -71,12 +71,17 @@ Check the [backup_borg role](https://github.com/mother-of-all-self-hosting/ansib ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Manually start a backup For testing your setup it can be helpful to not wait until 4am. If you want to run the backup immediately, log onto the server and run `systemctl start matrix-backup-borg`. This will not return until the backup is done, so possibly a long time. Consider using [tmux](https://en.wikipedia.org/wiki/Tmux) if your SSH connection is unstable. diff --git a/docs/configuring-playbook-bot-baibot.md b/docs/configuring-playbook-bot-baibot.md index be21ab98a..423fcf16b 100644 --- a/docs/configuring-playbook-bot-baibot.md +++ b/docs/configuring-playbook-bot-baibot.md @@ -376,18 +376,22 @@ matrix_bot_baibot_config_initial_global_config_handler_image_generation: null ## 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: + ```sh -just run-tags install-all,ensure-matrix-users-created,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` **Notes**: -- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. -- if you change the bot password (`matrix_bot_baibot_config_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_baibot_config_user_password` to let the bot know its new password +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- If you change the bot password (`matrix_bot_baibot_config_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_baibot_config_user_password` to let the bot know its new password. ## Usage diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md index d918f79ee..c1c00ecbe 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -56,18 +56,22 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` **Notes**: -- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. -- if you change the bot password (`matrix_bot_buscarron_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_buscarron_password` to let the bot know its new password +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- If you change the bot password (`matrix_bot_buscarron_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_buscarron_password` to let the bot know its new password. ## Usage diff --git a/docs/configuring-playbook-bot-chatgpt.md b/docs/configuring-playbook-bot-chatgpt.md index c1cc9ea3b..e892f2ea2 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -56,12 +56,20 @@ You will need to get tokens for ChatGPT. ## 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=install-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index b3427f1b0..7f34158d8 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -115,12 +115,22 @@ That is all you need to do due to that Draupnir can complete migration on its ow ## 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- If you change the Pantalaimon's password (`matrix_bot_draupnir_pantalaimon_password` in your `vars.yml` file) subsequently, its credentials on the homeserver won't be updated automatically. If you'd like to change the password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_draupnir_pantalaimon_password` to let Pantalaimon know its new password. ## Usage diff --git a/docs/configuring-playbook-bot-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index 359aa7fe5..42cbcdc98 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -219,12 +219,20 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bot-honoroit.md b/docs/configuring-playbook-bot-honoroit.md index 982c7ca0a..bf210dc02 100644 --- a/docs/configuring-playbook-bot-honoroit.md +++ b/docs/configuring-playbook-bot-honoroit.md @@ -48,18 +48,22 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` **Notes**: -- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. -- if you change the bot password (`matrix_bot_honoroit_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_honoroit_password` to let the bot know its new password +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- If you change the bot password (`matrix_bot_honoroit_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_honoroit_password` to let the bot know its new password. ## Usage diff --git a/docs/configuring-playbook-bot-matrix-registration-bot.md b/docs/configuring-playbook-bot-matrix-registration-bot.md index 2d6c55711..ef846f33f 100644 --- a/docs/configuring-playbook-bot-matrix-registration-bot.md +++ b/docs/configuring-playbook-bot-matrix-registration-bot.md @@ -32,7 +32,22 @@ The bot account will be created automatically. ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- If you change the bot password (`matrix_bot_matrix_registration_bot_bot_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_registration_bot_bot_password` to let the bot know its new password. ## Usage diff --git a/docs/configuring-playbook-bot-matrix-reminder-bot.md b/docs/configuring-playbook-bot-matrix-reminder-bot.md index 2bce34765..8142ac34f 100644 --- a/docs/configuring-playbook-bot-matrix-reminder-bot.md +++ b/docs/configuring-playbook-bot-matrix-reminder-bot.md @@ -27,18 +27,22 @@ matrix_bot_matrix_reminder_bot_reminders_timezone: Europe/London ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` **Notes**: -- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. -- if you change the bot password (`matrix_bot_matrix_reminder_bot_matrix_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_reminder_bot_matrix_user_password` to let the bot know its new password +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- If you change the bot password (`matrix_bot_matrix_reminder_bot_matrix_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_reminder_bot_matrix_user_password` to let the bot know its new password. ## Usage diff --git a/docs/configuring-playbook-bot-maubot.md b/docs/configuring-playbook-bot-maubot.md index 05320d7bb..45b76f47a 100644 --- a/docs/configuring-playbook-bot-maubot.md +++ b/docs/configuring-playbook-bot-maubot.md @@ -49,11 +49,22 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` **Notes**: -- if you change the bot password (`matrix_bot_maubot_initial_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_maubot_initial_password` to let the bot know its new password +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- If you change the bot password (`matrix_bot_maubot_initial_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_maubot_initial_password` to let the bot know its new password. ## Usage diff --git a/docs/configuring-playbook-bot-mjolnir.md b/docs/configuring-playbook-bot-mjolnir.md index 664a0a4ae..7d1be0404 100644 --- a/docs/configuring-playbook-bot-mjolnir.md +++ b/docs/configuring-playbook-bot-mjolnir.md @@ -117,12 +117,22 @@ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_ban_lists: [] ## 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- If you change the Pantalaimon's password (`matrix_bot_mjolnir_pantalaimon_password` in your `vars.yml` file) subsequently, its credentials on the homeserver won't be updated automatically. If you'd like to change the password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_mjolnir_pantalaimon_password` to let Pantalaimon know its new password. ## Usage diff --git a/docs/configuring-playbook-bridge-appservice-discord.md b/docs/configuring-playbook-bridge-appservice-discord.md index 7f5ee714b..760782da2 100644 --- a/docs/configuring-playbook-bridge-appservice-discord.md +++ b/docs/configuring-playbook-bridge-appservice-discord.md @@ -30,12 +30,21 @@ matrix_appservice_discord_bot_token: "YOUR DISCORD APP BOT TOKEN" ## 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Self-Service Bridging (Manual) Self-service bridging allows you to bridge specific and existing Matrix rooms to specific Discord rooms. To enable it, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: diff --git a/docs/configuring-playbook-bridge-appservice-irc.md b/docs/configuring-playbook-bridge-appservice-irc.md index 84c3b4dd4..cbd995e32 100644 --- a/docs/configuring-playbook-bridge-appservice-irc.md +++ b/docs/configuring-playbook-bridge-appservice-irc.md @@ -62,7 +62,20 @@ matrix_appservice_irc_ircService_servers: ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-appservice-kakaotalk.md b/docs/configuring-playbook-bridge-appservice-kakaotalk.md index 363f74709..4a85b2aed 100644 --- a/docs/configuring-playbook-bridge-appservice-kakaotalk.md +++ b/docs/configuring-playbook-bridge-appservice-kakaotalk.md @@ -33,12 +33,21 @@ Take a look at: ## 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Start a chat with `@kakaotalkbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-appservice-slack.md b/docs/configuring-playbook-bridge-appservice-slack.md index 1635ef77d..85196e189 100644 --- a/docs/configuring-playbook-bridge-appservice-slack.md +++ b/docs/configuring-playbook-bridge-appservice-slack.md @@ -65,12 +65,21 @@ Other configuration options are available via the `matrix_appservice_slack_confi ## 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Send `/invite @slackbot:example.com` to invite the bridge bot user into the admin room. diff --git a/docs/configuring-playbook-bridge-appservice-webhooks.md b/docs/configuring-playbook-bridge-appservice-webhooks.md index aea9f7f8a..a937e0583 100644 --- a/docs/configuring-playbook-bridge-appservice-webhooks.md +++ b/docs/configuring-playbook-bridge-appservice-webhooks.md @@ -26,12 +26,21 @@ matrix_appservice_webhooks_api_secret: '' ## 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Invite the bridge bot user to your room in either way. diff --git a/docs/configuring-playbook-bridge-beeper-linkedin.md b/docs/configuring-playbook-bridge-beeper-linkedin.md index 67133e50d..58fd43640 100644 --- a/docs/configuring-playbook-bridge-beeper-linkedin.md +++ b/docs/configuring-playbook-bridge-beeper-linkedin.md @@ -35,7 +35,20 @@ You may wish to look at `roles/custom/matrix-bridge-beeper-linkedin/templates/co ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Set up Double Puppeting by enabling Appservice Double Puppet or Shared Secret Auth diff --git a/docs/configuring-playbook-bridge-go-skype-bridge.md b/docs/configuring-playbook-bridge-go-skype-bridge.md index 2370f5fa4..03b20989d 100644 --- a/docs/configuring-playbook-bridge-go-skype-bridge.md +++ b/docs/configuring-playbook-bridge-go-skype-bridge.md @@ -14,7 +14,20 @@ matrix_go_skype_bridge_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-heisenbridge.md b/docs/configuring-playbook-bridge-heisenbridge.md index 34dc627a4..96b7ca2f2 100644 --- a/docs/configuring-playbook-bridge-heisenbridge.md +++ b/docs/configuring-playbook-bridge-heisenbridge.md @@ -49,7 +49,20 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -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` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-matrix-bridge-sms.md b/docs/configuring-playbook-bridge-matrix-bridge-sms.md index 6ac1e686a..25103d753 100644 --- a/docs/configuring-playbook-bridge-matrix-bridge-sms.md +++ b/docs/configuring-playbook-bridge-matrix-bridge-sms.md @@ -33,7 +33,20 @@ matrix_sms_bridge_provider_android_truststore_password: 123 ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-discord.md b/docs/configuring-playbook-bridge-mautrix-discord.md index 4938a975e..0f72110bb 100644 --- a/docs/configuring-playbook-bridge-mautrix-discord.md +++ b/docs/configuring-playbook-bridge-mautrix-discord.md @@ -42,12 +42,21 @@ Take a look at: ## 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage ### Logging in diff --git a/docs/configuring-playbook-bridge-mautrix-facebook.md b/docs/configuring-playbook-bridge-mautrix-facebook.md index 77bc5447d..8e41db1c6 100644 --- a/docs/configuring-playbook-bridge-mautrix-facebook.md +++ b/docs/configuring-playbook-bridge-mautrix-facebook.md @@ -55,7 +55,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-facebook/templates/c ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-gmessages.md b/docs/configuring-playbook-bridge-mautrix-gmessages.md index 00984faf5..c26b6e57e 100644 --- a/docs/configuring-playbook-bridge-mautrix-gmessages.md +++ b/docs/configuring-playbook-bridge-mautrix-gmessages.md @@ -20,7 +20,20 @@ matrix_mautrix_gmessages_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-googlechat.md b/docs/configuring-playbook-bridge-mautrix-googlechat.md index 0569276b6..4c368f2b9 100644 --- a/docs/configuring-playbook-bridge-mautrix-googlechat.md +++ b/docs/configuring-playbook-bridge-mautrix-googlechat.md @@ -20,7 +20,20 @@ matrix_mautrix_googlechat_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-hangouts.md b/docs/configuring-playbook-bridge-mautrix-hangouts.md index 26177adf0..fb64ed097 100644 --- a/docs/configuring-playbook-bridge-mautrix-hangouts.md +++ b/docs/configuring-playbook-bridge-mautrix-hangouts.md @@ -22,7 +22,20 @@ matrix_mautrix_hangouts_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-instagram.md b/docs/configuring-playbook-bridge-mautrix-instagram.md index b9130faf0..25a7b7d8b 100644 --- a/docs/configuring-playbook-bridge-mautrix-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-instagram.md @@ -42,7 +42,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-instagram/templates/ ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md index cb39b400d..cd70a8c42 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md @@ -68,7 +68,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-meta-instagram/templ ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md index ab788408c..7883ebc9d 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md @@ -82,7 +82,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-meta-messenger/templ ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-signal.md b/docs/configuring-playbook-bridge-mautrix-signal.md index 3b486d171..561bfac2a 100644 --- a/docs/configuring-playbook-bridge-mautrix-signal.md +++ b/docs/configuring-playbook-bridge-mautrix-signal.md @@ -68,7 +68,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-signal/templates/con ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-slack.md b/docs/configuring-playbook-bridge-mautrix-slack.md index 1653dd816..175202644 100644 --- a/docs/configuring-playbook-bridge-mautrix-slack.md +++ b/docs/configuring-playbook-bridge-mautrix-slack.md @@ -44,12 +44,21 @@ Take a look at: ## 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage 1. Start a chat with `@slackbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-telegram.md b/docs/configuring-playbook-bridge-mautrix-telegram.md index 7c1426ff8..7b7d73182 100644 --- a/docs/configuring-playbook-bridge-mautrix-telegram.md +++ b/docs/configuring-playbook-bridge-mautrix-telegram.md @@ -22,7 +22,20 @@ matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-twitter.md b/docs/configuring-playbook-bridge-mautrix-twitter.md index 5f7480cc8..6bde13c5a 100644 --- a/docs/configuring-playbook-bridge-mautrix-twitter.md +++ b/docs/configuring-playbook-bridge-mautrix-twitter.md @@ -22,7 +22,20 @@ matrix_mautrix_twitter_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-whatsapp.md b/docs/configuring-playbook-bridge-mautrix-whatsapp.md index e2f73918f..35adeb85c 100644 --- a/docs/configuring-playbook-bridge-mautrix-whatsapp.md +++ b/docs/configuring-playbook-bridge-mautrix-whatsapp.md @@ -36,7 +36,20 @@ If you want to activate the relay bot in a room, send `!wa set-relay`. To deacti ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-wsproxy.md b/docs/configuring-playbook-bridge-mautrix-wsproxy.md index cb0a9280a..ff9ff6246 100644 --- a/docs/configuring-playbook-bridge-mautrix-wsproxy.md +++ b/docs/configuring-playbook-bridge-mautrix-wsproxy.md @@ -41,7 +41,20 @@ By default, you will need to create a CNAME record for `wsproxy`. See [Configuri ## Installing -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` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mx-puppet-discord.md b/docs/configuring-playbook-bridge-mx-puppet-discord.md index c4958d4c4..3ab1b2ccf 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-discord.md +++ b/docs/configuring-playbook-bridge-mx-puppet-discord.md @@ -18,7 +18,20 @@ matrix_mx_puppet_discord_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mx-puppet-groupme.md b/docs/configuring-playbook-bridge-mx-puppet-groupme.md index 424aa8855..ee0cf065a 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-groupme.md +++ b/docs/configuring-playbook-bridge-mx-puppet-groupme.md @@ -14,7 +14,20 @@ matrix_mx_puppet_groupme_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mx-puppet-instagram.md b/docs/configuring-playbook-bridge-mx-puppet-instagram.md index 54bd0b011..3368dd579 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-instagram.md +++ b/docs/configuring-playbook-bridge-mx-puppet-instagram.md @@ -14,7 +14,20 @@ matrix_mx_puppet_instagram_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mx-puppet-slack.md b/docs/configuring-playbook-bridge-mx-puppet-slack.md index 5372f73f6..4cb19d1b6 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-slack.md +++ b/docs/configuring-playbook-bridge-mx-puppet-slack.md @@ -23,12 +23,21 @@ matrix_mx_puppet_slack_oauth_client_secret: "" ## 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: + ```sh -ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Once the bot is enabled you need to start a chat with `Slack Puppet Bridge` with the handle `@_slackpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mx-puppet-steam.md b/docs/configuring-playbook-bridge-mx-puppet-steam.md index 08a52bd18..56e37f714 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-steam.md +++ b/docs/configuring-playbook-bridge-mx-puppet-steam.md @@ -14,7 +14,20 @@ matrix_mx_puppet_steam_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-mx-puppet-twitter.md b/docs/configuring-playbook-bridge-mx-puppet-twitter.md index c84c63e54..11024cf82 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-twitter.md +++ b/docs/configuring-playbook-bridge-mx-puppet-twitter.md @@ -25,7 +25,20 @@ matrix_mx_puppet_twitter_environment: '' ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-postmoogle.md b/docs/configuring-playbook-bridge-postmoogle.md index 799c0fd65..d7e96d1d7 100644 --- a/docs/configuring-playbook-bridge-postmoogle.md +++ b/docs/configuring-playbook-bridge-postmoogle.md @@ -49,18 +49,22 @@ You will also need to add several DNS records so that Postmoogle can send emails ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` **Notes**: -- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create a user account of the bridge's bot +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create a user account of the bridge's bot. -- if you change the bridge's bot password (`matrix_postmoogle_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_postmoogle_password` to let the bot know its new password +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- If you change the bridge's bot password (`matrix_postmoogle_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_postmoogle_password` to let the bot know its new password. ## Usage diff --git a/docs/configuring-playbook-bridge-wechat.md b/docs/configuring-playbook-bridge-wechat.md index 8e57062e5..5663904a1 100644 --- a/docs/configuring-playbook-bridge-wechat.md +++ b/docs/configuring-playbook-bridge-wechat.md @@ -14,7 +14,20 @@ matrix_wechat_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-cactus-comments.md b/docs/configuring-playbook-cactus-comments.md index 0607e288e..6a3dd3f8d 100644 --- a/docs/configuring-playbook-cactus-comments.md +++ b/docs/configuring-playbook-cactus-comments.md @@ -63,7 +63,20 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -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` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-client-cinny.md b/docs/configuring-playbook-client-cinny.md index 64ede1606..513cc7f6a 100644 --- a/docs/configuring-playbook-client-cinny.md +++ b/docs/configuring-playbook-client-cinny.md @@ -42,4 +42,13 @@ If you've adjusted `matrix_client_cinny_hostname`, you will need to adjust your ## Installing -After configuring the playbook and [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook and [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-client-element-web.md b/docs/configuring-playbook-client-element-web.md index 35706e4d5..f410459e3 100644 --- a/docs/configuring-playbook-client-element-web.md +++ b/docs/configuring-playbook-client-element-web.md @@ -71,4 +71,13 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -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` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-client-hydrogen.md b/docs/configuring-playbook-client-hydrogen.md index 1715c9804..600fc3b95 100644 --- a/docs/configuring-playbook-client-hydrogen.md +++ b/docs/configuring-playbook-client-hydrogen.md @@ -39,4 +39,13 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -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` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-client-schildichat-web.md b/docs/configuring-playbook-client-schildichat-web.md index 0f5e6632c..780ac0829 100644 --- a/docs/configuring-playbook-client-schildichat-web.md +++ b/docs/configuring-playbook-client-schildichat-web.md @@ -69,4 +69,13 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -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` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-dendrite.md b/docs/configuring-playbook-dendrite.md index 0ffa8ed04..31d43c0e2 100644 --- a/docs/configuring-playbook-dendrite.md +++ b/docs/configuring-playbook-dendrite.md @@ -34,4 +34,13 @@ Alternatively, **if there is no pre-defined variable** for a Dendrite setting yo ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-dimension.md b/docs/configuring-playbook-dimension.md index 87365f26c..80645bcef 100644 --- a/docs/configuring-playbook-dimension.md +++ b/docs/configuring-playbook-dimension.md @@ -69,14 +69,20 @@ By default, you will need to create a CNAME record for `dimension`. See [Configu ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` -After Dimension has been installed you may need to log out and log back in for it to pick up the new integration manager. Then you can access integrations in Element Web by opening a room, clicking the Room info button (`i`) button in the top right corner of the screen, and then clicking Add widgets, bridges & bots. +**Notes**: +- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + + `just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- After Dimension has been installed you may need to log out and log back in for it to pick up the new integration manager. Then you can access integrations in Element Web by opening a room, clicking the Room info button (`i`) button in the top right corner of the screen, and then clicking Add widgets, bridges & bots. ## Jitsi domain diff --git a/docs/configuring-playbook-dynamic-dns.md b/docs/configuring-playbook-dynamic-dns.md index efabb75b9..e610f3b5f 100644 --- a/docs/configuring-playbook-dynamic-dns.md +++ b/docs/configuring-playbook-dynamic-dns.md @@ -25,7 +25,16 @@ matrix_dynamic_dns_domain_configurations: ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Additional Reading diff --git a/docs/configuring-playbook-email2matrix.md b/docs/configuring-playbook-email2matrix.md index ab274afe4..5b0bcd4fa 100644 --- a/docs/configuring-playbook-email2matrix.md +++ b/docs/configuring-playbook-email2matrix.md @@ -83,6 +83,16 @@ Refer to the official documentation [here](https://github.com/devture/email2matr ## Installing -To enable Email2Matrix, run the [installation](installing.md) command (`--tags=setup-email2matrix,start`). +To enable Email2Matrix, run the playbook with [playbook tags](playbook-tags.md) as below: -After installation, you may wish to send a test email to the email address assigned to `mailbox1` (default: `mailbox1@matrix.example.com`) to make sure that Email2Matrix works as expected. +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-email2matrix,start +``` + +**Notes**: + +- The shortcut commands with `just` program are also available: `just run-tags setup-email2matrix,start` or `just run-tags setup-all,start` + + `just run-tags setup-email2matrix,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- After installation, you may wish to send a test email to the email address assigned to `mailbox1` (default: `mailbox1@matrix.example.com`) to make sure that Email2Matrix works as expected. diff --git a/docs/configuring-playbook-etherpad.md b/docs/configuring-playbook-etherpad.md index 6bdc4a382..50ca562ed 100644 --- a/docs/configuring-playbook-etherpad.md +++ b/docs/configuring-playbook-etherpad.md @@ -44,7 +44,22 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## Installing -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` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the Etherpad admin user (`etherpad_admin_username`). + +- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + + `just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- If you change the Etherpad admin user's password (`etherpad_admin_password` in your `vars.yml` file) subsequently, the admin user's credentials on the homeserver won't be updated automatically. If you'd like to change the admin user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `etherpad_admin_password` to let the admin user know its new password. ## Usage diff --git a/docs/configuring-playbook-jitsi.md b/docs/configuring-playbook-jitsi.md index 623368b54..9ea3fb9e6 100644 --- a/docs/configuring-playbook-jitsi.md +++ b/docs/configuring-playbook-jitsi.md @@ -269,12 +269,17 @@ jitsi_disable_gravatar: false ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage You can use the self-hosted Jitsi server in multiple ways: diff --git a/docs/configuring-playbook-ma1sd.md b/docs/configuring-playbook-ma1sd.md index adebb4abd..42408aaed 100644 --- a/docs/configuring-playbook-ma1sd.md +++ b/docs/configuring-playbook-ma1sd.md @@ -131,7 +131,16 @@ matrix_ma1sd_configuration_extension_yaml: | ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Troubleshooting diff --git a/docs/configuring-playbook-matrix-authentication-service.md b/docs/configuring-playbook-matrix-authentication-service.md index fc79b7044..276c334fc 100644 --- a/docs/configuring-playbook-matrix-authentication-service.md +++ b/docs/configuring-playbook-matrix-authentication-service.md @@ -288,9 +288,20 @@ 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) and [your DNS records](#adjusting-dns-records), 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 playbook with [playbook tags](playbook-tags.md) as below: -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 Synapse homeserver to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service) guide. + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +**Notes**: + +- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + + `just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- 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 Synapse homeserver to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service) guide. 💡 After installation, you should [verify that Matrix Authentication Service is installed correctly](#verify-that-matrix-authentication-service-is-installed-correctly). diff --git a/docs/configuring-playbook-matrix-corporal.md b/docs/configuring-playbook-matrix-corporal.md index bb72dbb72..3127ea701 100644 --- a/docs/configuring-playbook-matrix-corporal.md +++ b/docs/configuring-playbook-matrix-corporal.md @@ -116,8 +116,16 @@ To learn more about what the policy configuration, see the matrix-corporal docum ## Installing -After configuring the playbook, run the [installation](installing.md) command (`--tags=setup-all,start` or `--tags=setup-aux-files,setup-corporal,start`). +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags setup-aux-files,setup-corporal,start` or `just run-tags setup-all,start` + +`just run-tags setup-aux-files,setup-corporal,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Matrix Corporal files diff --git a/docs/configuring-playbook-matrix-ldap-registration-proxy.md b/docs/configuring-playbook-matrix-ldap-registration-proxy.md index 828dee04a..02b04edf9 100644 --- a/docs/configuring-playbook-matrix-ldap-registration-proxy.md +++ b/docs/configuring-playbook-matrix-ldap-registration-proxy.md @@ -34,4 +34,13 @@ matrix_ldap_registration_proxy_systemd_wanted_services_list_custom: ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-matrix-registration.md b/docs/configuring-playbook-matrix-registration.md index 670562e34..3308d273e 100644 --- a/docs/configuring-playbook-matrix-registration.md +++ b/docs/configuring-playbook-matrix-registration.md @@ -52,12 +52,16 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage @@ -91,3 +95,5 @@ To **list the existing user registration tokens**, use this command: ansible-playbook -i inventory/hosts setup.yml \ --tags=list-matrix-registration-tokens ``` + +The shortcut command with `just` program is also available: `just run-tags list-matrix-registration-tokens` diff --git a/docs/configuring-playbook-mautrix-bridges.md b/docs/configuring-playbook-mautrix-bridges.md index 87482e039..99b9974d7 100644 --- a/docs/configuring-playbook-mautrix-bridges.md +++ b/docs/configuring-playbook-mautrix-bridges.md @@ -93,7 +93,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-SERVICENAME/template ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` + + `just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Set up Double Puppeting diff --git a/docs/configuring-playbook-ntfy.md b/docs/configuring-playbook-ntfy.md index 93db3c0f5..dab016207 100644 --- a/docs/configuring-playbook-ntfy.md +++ b/docs/configuring-playbook-ntfy.md @@ -50,12 +50,16 @@ By default, you will need to create a CNAME record for `ntfy`. See [Configuring ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-pantalaimon.md b/docs/configuring-playbook-pantalaimon.md index 91bc9a0d9..5b0478a92 100644 --- a/docs/configuring-playbook-pantalaimon.md +++ b/docs/configuring-playbook-pantalaimon.md @@ -18,4 +18,13 @@ The default configuration should suffice. For advanced configuration, you can ov ## 2. Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-postgres-backup.md b/docs/configuring-playbook-postgres-backup.md index b05dddca1..9d3967cbc 100644 --- a/docs/configuring-playbook-postgres-backup.md +++ b/docs/configuring-playbook-postgres-backup.md @@ -29,8 +29,13 @@ Refer to the table below for additional configuration variables and their defaul ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 440b9f224..ae9ec582b 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -55,7 +55,16 @@ By default, you will need to create a CNAME record for `stats`. See [Configuring ## Installing -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` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## What does it do? diff --git a/docs/configuring-playbook-prometheus-nginxlog.md b/docs/configuring-playbook-prometheus-nginxlog.md index e6ed3043a..c3c6081dd 100644 --- a/docs/configuring-playbook-prometheus-nginxlog.md +++ b/docs/configuring-playbook-prometheus-nginxlog.md @@ -22,7 +22,16 @@ matrix_prometheus_nginxlog_exporter_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Docker Image Compatibility diff --git a/docs/configuring-playbook-prometheus-postgres.md b/docs/configuring-playbook-prometheus-postgres.md index f24bc0818..7d71b1c33 100644 --- a/docs/configuring-playbook-prometheus-postgres.md +++ b/docs/configuring-playbook-prometheus-postgres.md @@ -12,7 +12,16 @@ prometheus_postgres_exporter_enabled: true ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## What does it do? diff --git a/docs/configuring-playbook-rageshake.md b/docs/configuring-playbook-rageshake.md index abc679d3f..b74eaeefd 100644 --- a/docs/configuring-playbook-rageshake.md +++ b/docs/configuring-playbook-rageshake.md @@ -51,12 +51,16 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-rest-auth.md b/docs/configuring-playbook-rest-auth.md index c9352c6c6..224978ba6 100644 --- a/docs/configuring-playbook-rest-auth.md +++ b/docs/configuring-playbook-rest-auth.md @@ -26,4 +26,13 @@ matrix_synapse_password_config_localdb_enabled: false ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-riot-web.md b/docs/configuring-playbook-riot-web.md index eb05e0267..ecc4e588f 100644 --- a/docs/configuring-playbook-riot-web.md +++ b/docs/configuring-playbook-riot-web.md @@ -30,4 +30,13 @@ There are a few options for handling this: ### Re-running the playbook -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-shared-secret-auth.md b/docs/configuring-playbook-shared-secret-auth.md index 0c11df290..4d702704c 100644 --- a/docs/configuring-playbook-shared-secret-auth.md +++ b/docs/configuring-playbook-shared-secret-auth.md @@ -25,4 +25,13 @@ matrix_synapse_password_config_localdb_enabled: false ## Installing -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-sliding-sync-proxy.md b/docs/configuring-playbook-sliding-sync-proxy.md index 52a9ee07c..491df75ba 100644 --- a/docs/configuring-playbook-sliding-sync-proxy.md +++ b/docs/configuring-playbook-sliding-sync-proxy.md @@ -39,7 +39,16 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all`. +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ### External databases diff --git a/docs/configuring-playbook-sygnal.md b/docs/configuring-playbook-sygnal.md index 004b9f9dc..af1101c02 100644 --- a/docs/configuring-playbook-sygnal.md +++ b/docs/configuring-playbook-sygnal.md @@ -77,12 +77,16 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-synapse-admin.md b/docs/configuring-playbook-synapse-admin.md index 24547452e..a6b52fa9c 100644 --- a/docs/configuring-playbook-synapse-admin.md +++ b/docs/configuring-playbook-synapse-admin.md @@ -48,7 +48,16 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## 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: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-synapse-auto-compressor.md b/docs/configuring-playbook-synapse-auto-compressor.md index 3a3a310d2..94c85c76b 100644 --- a/docs/configuring-playbook-synapse-auto-compressor.md +++ b/docs/configuring-playbook-synapse-auto-compressor.md @@ -18,12 +18,16 @@ matrix_synapse_auto_compressor_enabled: true ## 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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-synapse-usage-exporter.md b/docs/configuring-playbook-synapse-usage-exporter.md index b3180281a..996ee2f03 100644 --- a/docs/configuring-playbook-synapse-usage-exporter.md +++ b/docs/configuring-playbook-synapse-usage-exporter.md @@ -50,4 +50,13 @@ If you've decided to use the default hostname, you won't need to do any extra DN ## Installing -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` +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + +`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-user-verification-service.md b/docs/configuring-playbook-user-verification-service.md index 0664ae826..0e1031028 100644 --- a/docs/configuring-playbook-user-verification-service.md +++ b/docs/configuring-playbook-user-verification-service.md @@ -90,12 +90,16 @@ This will instruct UVS to verify the OpenID token against any domain given in a ## 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 ansible-playbook -i inventory/hosts setup.yml --tags=setup-matrix-user-verification-service,start ``` +The shortcut commands with `just` program are also available: `just run-tags setup-matrix-user-verification-service,start` or `just run-tags setup-all,start` + +`just run-tags setup-matrix-user-verification-service,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Logging The configuration variable `UVS_LOG_LEVEL` can be set to: diff --git a/docs/faq.md b/docs/faq.md index 6afd37700..283604868 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -269,13 +269,20 @@ matrix_server_fqn_element: "element.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: + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` -**Note**: without setting up [server delegation](howto-server-delegation.md) to `matrix.example.com`, your user identifiers will be like `@user:matrix.example.com`. This is equivalent to having an email address like `bob@mail.company.com`, instead of just `bob@company.com`. +**Notes**: + +- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + + `just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- Without setting up [server delegation](howto-server-delegation.md) to `matrix.example.com`, your user identifiers will be like `@user:matrix.example.com`. This is equivalent to having an email address like `bob@mail.company.com`, instead of just `bob@company.com`. ### I don't use the base domain for anything. How am I supposed to set up Server Delegation for Matrix services? diff --git a/docs/importing-synapse-media-store.md b/docs/importing-synapse-media-store.md index 01180edab..4b6c1d336 100644 --- a/docs/importing-synapse-media-store.md +++ b/docs/importing-synapse-media-store.md @@ -18,6 +18,8 @@ As an alternative, you can perform a manual restore using the [AWS CLI tool](htt Run this command (make sure to replace `` with a path on your server): - ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_media_store=' --tags=import-synapse-media-store +```sh +ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_media_store=' --tags=import-synapse-media-store +``` **Note**: `` must be a file path to a `media_store` directory on the server (not on your local machine!). diff --git a/docs/maintenance-and-troubleshooting.md b/docs/maintenance-and-troubleshooting.md index c8803c844..586701da2 100644 --- a/docs/maintenance-and-troubleshooting.md +++ b/docs/maintenance-and-troubleshooting.md @@ -41,10 +41,13 @@ Re-run the playbook after making these configuration changes. ## Remove unused Docker data You can free some disk space from Docker, see [docker system prune](https://docs.docker.com/engine/reference/commandline/system_prune/) for more information. + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=run-docker-prune ``` +The shortcut command with `just` program is also available: `just run-tags run-docker-prune` + ## Postgres See the dedicated [PostgreSQL Maintenance](maintenance-postgres.md) documentation page. diff --git a/docs/maintenance-checking-services.md b/docs/maintenance-checking-services.md index e6975b9d1..d68502357 100644 --- a/docs/maintenance-checking-services.md +++ b/docs/maintenance-checking-services.md @@ -8,6 +8,8 @@ To perform the check, run: ansible-playbook -i inventory/hosts setup.yml --tags=self-check ``` +The shortcut command with `just` program is also available: `just run-tags self-check` + If it's all green, everything is probably running correctly. Besides this self-check, you can also check whether your server federates with the Matrix network by using the [Federation Tester](https://federationtester.matrix.org/) against your base domain (`example.com`), not the `matrix.example.com` subdomain. diff --git a/docs/maintenance-migrating.md b/docs/maintenance-migrating.md index 29a2beb52..e2c0a7efa 100644 --- a/docs/maintenance-migrating.md +++ b/docs/maintenance-migrating.md @@ -46,6 +46,8 @@ Then, run the command below on your local computer to create the `matrix` user a ansible-playbook -i inventory/hosts setup.yml --tags=setup-system-user ``` +The shortcut command with `just` program is also available: `just run-tags setup-system-user` + **Note**: because the `matrix` user and group are created dynamically on each server, the user/group ID may differ between the old and new server. We suggest that you adjust ownership of `/matrix` files. To adjust the ownership, log in to the new server and run the command: ```sh @@ -60,6 +62,8 @@ Finally, run the command below on your local computer to finish the installation ansible-playbook -i inventory/hosts setup.yml --tags=install-all,start ``` +The shortcut command with `just` program is also available: `just run-tags install-all,start` + ### Check if services work After starting the services, you probably might want to ensure that you've migrated things correctly and that services are running. For instructions, see: [check if services work](maintenance-checking-services.md) diff --git a/docs/maintenance-synapse.md b/docs/maintenance-synapse.md index fdf2856d7..91e79661c 100644 --- a/docs/maintenance-synapse.md +++ b/docs/maintenance-synapse.md @@ -39,6 +39,8 @@ To ask the playbook to run rust-synapse-compress-state, execute: ansible-playbook -i inventory/hosts setup.yml --tags=rust-synapse-compress-state ``` +The shortcut command with `just` program is also available: `just run-tags rust-synapse-compress-state` + By default, all rooms with more than `100000` state group rows will be compressed. If you need to adjust this, pass: `--extra-vars='matrix_synapse_rust_synapse_compress_state_min_state_groups_required=SOME_NUMBER_HERE'` to the command above. After state compression, you may wish to run a [`FULL` Postgres `VACUUM`](./maintenance-postgres.md#vacuuming-postgresql). diff --git a/docs/registering-users.md b/docs/registering-users.md index 3701b23e6..1633f162a 100644 --- a/docs/registering-users.md +++ b/docs/registering-users.md @@ -112,10 +112,20 @@ For Dendrite: matrix_dendrite_client_api_registration_disabled: false ``` -After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: -If you're opening up registrations publicly like this, you might also wish to [configure CAPTCHA protection](configuring-captcha.md). + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` +**Notes**: + +- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` + + `just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + +- If you're opening up registrations publicly like this, you might also wish to [configure CAPTCHA protection](configuring-captcha.md). ## Adding/Removing Administrator privileges to an existing user