From 5459b1d03ac2641284d0199efe27a5ae5fb82c54 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 30 Nov 2024 03:01:56 +0900 Subject: [PATCH] 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 --- docs/configuring-playbook-alertmanager-receiver.md | 8 ++++++-- docs/configuring-playbook-appservice-double-puppet.md | 8 ++++++-- ...onfiguring-playbook-appservice-draupnir-for-all.md | 8 ++++++-- docs/configuring-playbook-backup-borg.md | 2 +- docs/configuring-playbook-bot-baibot.md | 11 +++++------ docs/configuring-playbook-bot-buscarron.md | 10 +++++----- docs/configuring-playbook-bot-chatgpt.md | 8 ++++++-- docs/configuring-playbook-bot-draupnir.md | 8 ++++++-- docs/configuring-playbook-bot-go-neb.md | 8 ++++++-- docs/configuring-playbook-bot-honoroit.md | 10 +++++----- ...onfiguring-playbook-bot-matrix-registration-bot.md | 8 ++++++-- docs/configuring-playbook-bot-matrix-reminder-bot.md | 10 +++++----- docs/configuring-playbook-bot-maubot.md | 10 ++++++---- docs/configuring-playbook-bot-mjolnir.md | 8 ++++++-- .../configuring-playbook-bridge-appservice-discord.md | 8 ++++++-- docs/configuring-playbook-bridge-appservice-irc.md | 8 ++++++-- ...onfiguring-playbook-bridge-appservice-kakaotalk.md | 8 ++++++-- docs/configuring-playbook-bridge-appservice-slack.md | 8 ++++++-- ...configuring-playbook-bridge-appservice-webhooks.md | 8 ++++++-- docs/configuring-playbook-bridge-beeper-linkedin.md | 8 ++++++-- docs/configuring-playbook-bridge-go-skype-bridge.md | 8 ++++++-- docs/configuring-playbook-bridge-heisenbridge.md | 8 ++++++-- docs/configuring-playbook-bridge-matrix-bridge-sms.md | 8 ++++++-- docs/configuring-playbook-bridge-mautrix-discord.md | 8 ++++++-- docs/configuring-playbook-bridge-mautrix-facebook.md | 8 ++++++-- docs/configuring-playbook-bridge-mautrix-gmessages.md | 8 ++++++-- .../configuring-playbook-bridge-mautrix-googlechat.md | 8 ++++++-- docs/configuring-playbook-bridge-mautrix-hangouts.md | 8 ++++++-- docs/configuring-playbook-bridge-mautrix-instagram.md | 8 ++++++-- ...figuring-playbook-bridge-mautrix-meta-instagram.md | 8 ++++++-- ...figuring-playbook-bridge-mautrix-meta-messenger.md | 8 ++++++-- docs/configuring-playbook-bridge-mautrix-signal.md | 8 ++++++-- docs/configuring-playbook-bridge-mautrix-slack.md | 8 ++++++-- docs/configuring-playbook-bridge-mautrix-telegram.md | 8 ++++++-- docs/configuring-playbook-bridge-mautrix-twitter.md | 8 ++++++-- docs/configuring-playbook-bridge-mautrix-whatsapp.md | 8 ++++++-- docs/configuring-playbook-bridge-mautrix-wsproxy.md | 8 ++++++-- docs/configuring-playbook-bridge-mx-puppet-discord.md | 8 ++++++-- docs/configuring-playbook-bridge-mx-puppet-groupme.md | 8 ++++++-- ...configuring-playbook-bridge-mx-puppet-instagram.md | 8 ++++++-- docs/configuring-playbook-bridge-mx-puppet-slack.md | 8 ++++++-- docs/configuring-playbook-bridge-mx-puppet-steam.md | 8 ++++++-- docs/configuring-playbook-bridge-mx-puppet-twitter.md | 8 ++++++-- docs/configuring-playbook-bridge-postmoogle.md | 11 +++++------ docs/configuring-playbook-bridge-wechat.md | 8 ++++++-- docs/configuring-playbook-cactus-comments.md | 8 ++++++-- docs/configuring-playbook-client-cinny.md | 2 +- docs/configuring-playbook-client-element-web.md | 2 +- docs/configuring-playbook-client-hydrogen.md | 2 +- docs/configuring-playbook-client-schildichat-web.md | 2 +- docs/configuring-playbook-dendrite.md | 2 +- docs/configuring-playbook-dimension.md | 2 +- docs/configuring-playbook-dynamic-dns.md | 2 +- docs/configuring-playbook-etherpad.md | 8 ++++++-- docs/configuring-playbook-jitsi.md | 2 +- docs/configuring-playbook-ma1sd.md | 2 +- ...figuring-playbook-matrix-authentication-service.md | 2 +- ...iguring-playbook-matrix-ldap-registration-proxy.md | 2 +- docs/configuring-playbook-matrix-registration.md | 4 ++-- docs/configuring-playbook-mautrix-bridges.md | 8 ++++++-- docs/configuring-playbook-ntfy.md | 2 +- docs/configuring-playbook-pantalaimon.md | 2 +- docs/configuring-playbook-postgres-backup.md | 2 +- docs/configuring-playbook-prometheus-grafana.md | 2 +- docs/configuring-playbook-prometheus-nginxlog.md | 2 +- docs/configuring-playbook-prometheus-postgres.md | 2 +- docs/configuring-playbook-rageshake.md | 2 +- docs/configuring-playbook-rest-auth.md | 2 +- docs/configuring-playbook-riot-web.md | 2 +- docs/configuring-playbook-shared-secret-auth.md | 2 +- docs/configuring-playbook-sliding-sync-proxy.md | 2 +- docs/configuring-playbook-sygnal.md | 2 +- docs/configuring-playbook-synapse-auto-compressor.md | 2 +- docs/configuring-playbook-synapse-usage-exporter.md | 2 +- .../configuring-playbook-user-verification-service.md | 2 +- docs/faq.md | 2 +- docs/maintenance-and-troubleshooting.md | 2 +- docs/maintenance-checking-services.md | 2 +- docs/maintenance-migrating.md | 4 ++-- docs/maintenance-synapse.md | 2 +- docs/registering-users.md | 2 +- 81 files changed, 313 insertions(+), 149 deletions(-) diff --git a/docs/configuring-playbook-alertmanager-receiver.md b/docs/configuring-playbook-alertmanager-receiver.md index 59a296bac..e58b4d03c 100644 --- a/docs/configuring-playbook-alertmanager-receiver.md +++ b/docs/configuring-playbook-alertmanager-receiver.md @@ -83,9 +83,13 @@ Now that you've [prepared the bot account and room](#account-and-room-preparatio ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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) Then, you can proceed to [Usage](#usage). diff --git a/docs/configuring-playbook-appservice-double-puppet.md b/docs/configuring-playbook-appservice-double-puppet.md index c36e7da65..595becf7d 100644 --- a/docs/configuring-playbook-appservice-double-puppet.md +++ b/docs/configuring-playbook-appservice-double-puppet.md @@ -23,9 +23,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 e1054e106..4e5075508 100644 --- a/docs/configuring-playbook-appservice-draupnir-for-all.md +++ b/docs/configuring-playbook-appservice-draupnir-for-all.md @@ -56,9 +56,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 62d0b08d9..37a2d7aab 100644 --- a/docs/configuring-playbook-backup-borg.md +++ b/docs/configuring-playbook-backup-borg.md @@ -78,7 +78,7 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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-bot-baibot.md b/docs/configuring-playbook-bot-baibot.md index 5156c4a5f..1d4616235 100644 --- a/docs/configuring-playbook-bot-baibot.md +++ b/docs/configuring-playbook-bot-baibot.md @@ -383,16 +383,15 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -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) - **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. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` -- 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 + `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 2e0f55d6e..40412d865 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -63,15 +63,15 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. -**Notes**: +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` -- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account + `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 +- 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 d3ccc7b39..f9dd615ea 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -63,9 +63,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 c7c2157a1..27524ca85 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -122,9 +122,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index 8392e4479..b48622752 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -226,9 +226,13 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 8f334dd79..69c327f79 100644 --- a/docs/configuring-playbook-bot-honoroit.md +++ b/docs/configuring-playbook-bot-honoroit.md @@ -55,15 +55,15 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. -**Notes**: +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` -- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account + `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 +- 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 d1fa4cc41..df5cb934e 100644 --- a/docs/configuring-playbook-bot-matrix-registration-bot.md +++ b/docs/configuring-playbook-bot-matrix-registration-bot.md @@ -39,9 +39,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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-matrix-reminder-bot.md b/docs/configuring-playbook-bot-matrix-reminder-bot.md index db79e86f0..ab560d4aa 100644 --- a/docs/configuring-playbook-bot-matrix-reminder-bot.md +++ b/docs/configuring-playbook-bot-matrix-reminder-bot.md @@ -34,15 +34,15 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. -**Notes**: +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` -- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account + `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 +- 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 4478e9718..856e29f90 100644 --- a/docs/configuring-playbook-bot-maubot.md +++ b/docs/configuring-playbook-bot-maubot.md @@ -56,13 +56,15 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account. -**Notes**: +- 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 +- 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 0ad61adb7..28a21c334 100644 --- a/docs/configuring-playbook-bot-mjolnir.md +++ b/docs/configuring-playbook-bot-mjolnir.md @@ -124,9 +124,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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-discord.md b/docs/configuring-playbook-bridge-appservice-discord.md index 4b1c41721..757052aab 100644 --- a/docs/configuring-playbook-bridge-appservice-discord.md +++ b/docs/configuring-playbook-bridge-appservice-discord.md @@ -37,9 +37,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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) diff --git a/docs/configuring-playbook-bridge-appservice-irc.md b/docs/configuring-playbook-bridge-appservice-irc.md index bbd1ed8be..6263db4c6 100644 --- a/docs/configuring-playbook-bridge-appservice-irc.md +++ b/docs/configuring-playbook-bridge-appservice-irc.md @@ -69,9 +69,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 38eb272e9..fe4291f86 100644 --- a/docs/configuring-playbook-bridge-appservice-kakaotalk.md +++ b/docs/configuring-playbook-bridge-appservice-kakaotalk.md @@ -40,9 +40,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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-slack.md b/docs/configuring-playbook-bridge-appservice-slack.md index f2e5084d8..d97b1a532 100644 --- a/docs/configuring-playbook-bridge-appservice-slack.md +++ b/docs/configuring-playbook-bridge-appservice-slack.md @@ -72,9 +72,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**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) + `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-webhooks.md b/docs/configuring-playbook-bridge-appservice-webhooks.md index d142f4345..5ee253721 100644 --- a/docs/configuring-playbook-bridge-appservice-webhooks.md +++ b/docs/configuring-playbook-bridge-appservice-webhooks.md @@ -33,9 +33,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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-beeper-linkedin.md b/docs/configuring-playbook-bridge-beeper-linkedin.md index aebd3b977..6b66685ae 100644 --- a/docs/configuring-playbook-bridge-beeper-linkedin.md +++ b/docs/configuring-playbook-bridge-beeper-linkedin.md @@ -42,9 +42,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 1848bb127..b97f6cf4e 100644 --- a/docs/configuring-playbook-bridge-go-skype-bridge.md +++ b/docs/configuring-playbook-bridge-go-skype-bridge.md @@ -21,9 +21,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 943bb7a62..76870c704 100644 --- a/docs/configuring-playbook-bridge-heisenbridge.md +++ b/docs/configuring-playbook-bridge-heisenbridge.md @@ -56,9 +56,13 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 ecfabf5f3..888fc1843 100644 --- a/docs/configuring-playbook-bridge-matrix-bridge-sms.md +++ b/docs/configuring-playbook-bridge-matrix-bridge-sms.md @@ -40,9 +40,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 d805e3fb3..c65e51417 100644 --- a/docs/configuring-playbook-bridge-mautrix-discord.md +++ b/docs/configuring-playbook-bridge-mautrix-discord.md @@ -49,9 +49,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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-facebook.md b/docs/configuring-playbook-bridge-mautrix-facebook.md index d83e85c9c..e4d163425 100644 --- a/docs/configuring-playbook-bridge-mautrix-facebook.md +++ b/docs/configuring-playbook-bridge-mautrix-facebook.md @@ -62,9 +62,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 13665208b..95a5a334a 100644 --- a/docs/configuring-playbook-bridge-mautrix-gmessages.md +++ b/docs/configuring-playbook-bridge-mautrix-gmessages.md @@ -27,9 +27,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 1d76b1e7c..ad02bd80e 100644 --- a/docs/configuring-playbook-bridge-mautrix-googlechat.md +++ b/docs/configuring-playbook-bridge-mautrix-googlechat.md @@ -27,9 +27,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 548c03405..69aa8f210 100644 --- a/docs/configuring-playbook-bridge-mautrix-hangouts.md +++ b/docs/configuring-playbook-bridge-mautrix-hangouts.md @@ -29,9 +29,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 529f017eb..4abd835ff 100644 --- a/docs/configuring-playbook-bridge-mautrix-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-instagram.md @@ -49,9 +49,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 1516c58b4..f136e2c63 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md @@ -75,9 +75,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 91a32da74..c0e3668cf 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md @@ -89,9 +89,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 e9475ef16..14ab762b1 100644 --- a/docs/configuring-playbook-bridge-mautrix-signal.md +++ b/docs/configuring-playbook-bridge-mautrix-signal.md @@ -75,9 +75,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 2478de660..71ba8a9bb 100644 --- a/docs/configuring-playbook-bridge-mautrix-slack.md +++ b/docs/configuring-playbook-bridge-mautrix-slack.md @@ -51,9 +51,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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-telegram.md b/docs/configuring-playbook-bridge-mautrix-telegram.md index 782de60f1..9516e1819 100644 --- a/docs/configuring-playbook-bridge-mautrix-telegram.md +++ b/docs/configuring-playbook-bridge-mautrix-telegram.md @@ -29,9 +29,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 a085736a4..8340caff8 100644 --- a/docs/configuring-playbook-bridge-mautrix-twitter.md +++ b/docs/configuring-playbook-bridge-mautrix-twitter.md @@ -29,9 +29,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 6a23f5a89..ae4164de1 100644 --- a/docs/configuring-playbook-bridge-mautrix-whatsapp.md +++ b/docs/configuring-playbook-bridge-mautrix-whatsapp.md @@ -43,9 +43,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 ddfbb9eda..d858fa0f0 100644 --- a/docs/configuring-playbook-bridge-mautrix-wsproxy.md +++ b/docs/configuring-playbook-bridge-mautrix-wsproxy.md @@ -48,9 +48,13 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 2fd9b5286..fbc1eeea7 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-discord.md +++ b/docs/configuring-playbook-bridge-mx-puppet-discord.md @@ -25,9 +25,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 753617395..7aa228161 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-groupme.md +++ b/docs/configuring-playbook-bridge-mx-puppet-groupme.md @@ -21,9 +21,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 cbc056377..2300f28c0 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-instagram.md +++ b/docs/configuring-playbook-bridge-mx-puppet-instagram.md @@ -21,9 +21,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 68c2cc7c0..9f2b2b5c8 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-slack.md +++ b/docs/configuring-playbook-bridge-mx-puppet-slack.md @@ -30,9 +30,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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-steam.md b/docs/configuring-playbook-bridge-mx-puppet-steam.md index 67211f44d..90b749812 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-steam.md +++ b/docs/configuring-playbook-bridge-mx-puppet-steam.md @@ -21,9 +21,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 47907d5e7..cdda97a58 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-twitter.md +++ b/docs/configuring-playbook-bridge-mx-puppet-twitter.md @@ -32,9 +32,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 03f4f7f5e..d9d07bc64 100644 --- a/docs/configuring-playbook-bridge-postmoogle.md +++ b/docs/configuring-playbook-bridge-postmoogle.md @@ -56,16 +56,15 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -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) - **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. + +- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all` -- 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 + `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 74820f379..4c494c36b 100644 --- a/docs/configuring-playbook-bridge-wechat.md +++ b/docs/configuring-playbook-bridge-wechat.md @@ -21,9 +21,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 ccc8477a8..faa46d27a 100644 --- a/docs/configuring-playbook-cactus-comments.md +++ b/docs/configuring-playbook-cactus-comments.md @@ -70,9 +70,13 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 6cd9c30bb..08849c8bc 100644 --- a/docs/configuring-playbook-client-cinny.md +++ b/docs/configuring-playbook-client-cinny.md @@ -49,6 +49,6 @@ After configuring the playbook and [adjusting your DNS records](#adjusting-dns-r 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`. +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 ef8266fd7..333f89a2e 100644 --- a/docs/configuring-playbook-client-element-web.md +++ b/docs/configuring-playbook-client-element-web.md @@ -78,6 +78,6 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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 89bf61310..1b4840d6b 100644 --- a/docs/configuring-playbook-client-hydrogen.md +++ b/docs/configuring-playbook-client-hydrogen.md @@ -46,6 +46,6 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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 c11b94586..a6cd4a439 100644 --- a/docs/configuring-playbook-client-schildichat-web.md +++ b/docs/configuring-playbook-client-schildichat-web.md @@ -76,6 +76,6 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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 7b2e77b08..99e93b50d 100644 --- a/docs/configuring-playbook-dendrite.md +++ b/docs/configuring-playbook-dendrite.md @@ -41,6 +41,6 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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 6e5d626cd..f7662b24a 100644 --- a/docs/configuring-playbook-dimension.md +++ b/docs/configuring-playbook-dimension.md @@ -76,7 +76,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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-dynamic-dns.md b/docs/configuring-playbook-dynamic-dns.md index ff9242c48..25d7a33ab 100644 --- a/docs/configuring-playbook-dynamic-dns.md +++ b/docs/configuring-playbook-dynamic-dns.md @@ -32,7 +32,7 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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-etherpad.md b/docs/configuring-playbook-etherpad.md index 354ab3e72..745846c94 100644 --- a/docs/configuring-playbook-etherpad.md +++ b/docs/configuring-playbook-etherpad.md @@ -51,9 +51,13 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`. +**Notes**: -`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) +- 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) ## Usage diff --git a/docs/configuring-playbook-jitsi.md b/docs/configuring-playbook-jitsi.md index d707be79e..dd85f7793 100644 --- a/docs/configuring-playbook-jitsi.md +++ b/docs/configuring-playbook-jitsi.md @@ -276,7 +276,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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-ma1sd.md b/docs/configuring-playbook-ma1sd.md index b5a24f613..eae7af439 100644 --- a/docs/configuring-playbook-ma1sd.md +++ b/docs/configuring-playbook-ma1sd.md @@ -138,7 +138,7 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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-authentication-service.md b/docs/configuring-playbook-matrix-authentication-service.md index d6543b696..f7e025a7a 100644 --- a/docs/configuring-playbook-matrix-authentication-service.md +++ b/docs/configuring-playbook-matrix-authentication-service.md @@ -295,7 +295,7 @@ Now that you've [adjusted the playbook configuration](#adjusting-the-playbook-co 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`. +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-ldap-registration-proxy.md b/docs/configuring-playbook-matrix-ldap-registration-proxy.md index 859b3715a..b3d4a7f28 100644 --- a/docs/configuring-playbook-matrix-ldap-registration-proxy.md +++ b/docs/configuring-playbook-matrix-ldap-registration-proxy.md @@ -41,6 +41,6 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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 155a93c67..fd9641629 100644 --- a/docs/configuring-playbook-matrix-registration.md +++ b/docs/configuring-playbook-matrix-registration.md @@ -59,7 +59,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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) @@ -96,4 +96,4 @@ 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`. +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 5dc17ac15..1f1f3aae0 100644 --- a/docs/configuring-playbook-mautrix-bridges.md +++ b/docs/configuring-playbook-mautrix-bridges.md @@ -100,9 +100,13 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` -The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. +**Notes**: -`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) +- 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 008daa2cf..0ed2c2708 100644 --- a/docs/configuring-playbook-ntfy.md +++ b/docs/configuring-playbook-ntfy.md @@ -57,7 +57,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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-pantalaimon.md b/docs/configuring-playbook-pantalaimon.md index da6d93b7d..fe4668965 100644 --- a/docs/configuring-playbook-pantalaimon.md +++ b/docs/configuring-playbook-pantalaimon.md @@ -25,6 +25,6 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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 6969dbacc..65b9cd88c 100644 --- a/docs/configuring-playbook-postgres-backup.md +++ b/docs/configuring-playbook-postgres-backup.md @@ -36,6 +36,6 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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 a989cd936..86cd77efc 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -62,7 +62,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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-nginxlog.md b/docs/configuring-playbook-prometheus-nginxlog.md index c4e9578c5..230c445cd 100644 --- a/docs/configuring-playbook-prometheus-nginxlog.md +++ b/docs/configuring-playbook-prometheus-nginxlog.md @@ -29,7 +29,7 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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-postgres.md b/docs/configuring-playbook-prometheus-postgres.md index d458985ac..384df2824 100644 --- a/docs/configuring-playbook-prometheus-postgres.md +++ b/docs/configuring-playbook-prometheus-postgres.md @@ -19,7 +19,7 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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-rageshake.md b/docs/configuring-playbook-rageshake.md index f53fff861..5a001bd61 100644 --- a/docs/configuring-playbook-rageshake.md +++ b/docs/configuring-playbook-rageshake.md @@ -58,7 +58,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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-rest-auth.md b/docs/configuring-playbook-rest-auth.md index 6ab74a27b..f7589edc4 100644 --- a/docs/configuring-playbook-rest-auth.md +++ b/docs/configuring-playbook-rest-auth.md @@ -33,6 +33,6 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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 d0bb571d7..0eff73627 100644 --- a/docs/configuring-playbook-riot-web.md +++ b/docs/configuring-playbook-riot-web.md @@ -37,6 +37,6 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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 510a32e0a..e7947bd38 100644 --- a/docs/configuring-playbook-shared-secret-auth.md +++ b/docs/configuring-playbook-shared-secret-auth.md @@ -32,6 +32,6 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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 81f8883fd..9c45994c4 100644 --- a/docs/configuring-playbook-sliding-sync-proxy.md +++ b/docs/configuring-playbook-sliding-sync-proxy.md @@ -46,7 +46,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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-sygnal.md b/docs/configuring-playbook-sygnal.md index 6e08c5402..fa77aecf2 100644 --- a/docs/configuring-playbook-sygnal.md +++ b/docs/configuring-playbook-sygnal.md @@ -84,7 +84,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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-synapse-auto-compressor.md b/docs/configuring-playbook-synapse-auto-compressor.md index 32f9fb701..eac7499c0 100644 --- a/docs/configuring-playbook-synapse-auto-compressor.md +++ b/docs/configuring-playbook-synapse-auto-compressor.md @@ -25,7 +25,7 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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-synapse-usage-exporter.md b/docs/configuring-playbook-synapse-usage-exporter.md index 3d0c08b02..81f242843 100644 --- a/docs/configuring-playbook-synapse-usage-exporter.md +++ b/docs/configuring-playbook-synapse-usage-exporter.md @@ -57,6 +57,6 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj 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`. +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 5bfce212c..6f9695daf 100644 --- a/docs/configuring-playbook-user-verification-service.md +++ b/docs/configuring-playbook-user-verification-service.md @@ -96,7 +96,7 @@ After these variables have been set, run the [installation](installing.md) comma 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`. +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) diff --git a/docs/faq.md b/docs/faq.md index 352e92493..cdb73d1e1 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -276,7 +276,7 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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/maintenance-and-troubleshooting.md b/docs/maintenance-and-troubleshooting.md index 158d7abae..586701da2 100644 --- a/docs/maintenance-and-troubleshooting.md +++ b/docs/maintenance-and-troubleshooting.md @@ -46,7 +46,7 @@ You can free some disk space from Docker, see [docker system prune](https://docs 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`. +The shortcut command with `just` program is also available: `just run-tags run-docker-prune` ## Postgres diff --git a/docs/maintenance-checking-services.md b/docs/maintenance-checking-services.md index 672df9d9c..d68502357 100644 --- a/docs/maintenance-checking-services.md +++ b/docs/maintenance-checking-services.md @@ -8,7 +8,7 @@ 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`. +The shortcut command with `just` program is also available: `just run-tags self-check` If it's all green, everything is probably running correctly. diff --git a/docs/maintenance-migrating.md b/docs/maintenance-migrating.md index f9c37eb6d..e2c0a7efa 100644 --- a/docs/maintenance-migrating.md +++ b/docs/maintenance-migrating.md @@ -46,7 +46,7 @@ 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`. +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: @@ -62,7 +62,7 @@ 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`. +The shortcut command with `just` program is also available: `just run-tags install-all,start` ### Check if services work diff --git a/docs/maintenance-synapse.md b/docs/maintenance-synapse.md index 3ccc04c16..91e79661c 100644 --- a/docs/maintenance-synapse.md +++ b/docs/maintenance-synapse.md @@ -39,7 +39,7 @@ 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`. +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. diff --git a/docs/registering-users.md b/docs/registering-users.md index 29f4ae405..438d8f332 100644 --- a/docs/registering-users.md +++ b/docs/registering-users.md @@ -119,7 +119,7 @@ After configuring the playbook, run the [installation](installing.md) command: 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`. +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)