diff --git a/docs/configuring-playbook-alertmanager-receiver.md b/docs/configuring-playbook-alertmanager-receiver.md index 1507d3bd9a5..635cb2e0e7c 100644 --- a/docs/configuring-playbook-alertmanager-receiver.md +++ b/docs/configuring-playbook-alertmanager-receiver.md @@ -87,9 +87,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-appservice-double-puppet.md b/docs/configuring-playbook-appservice-double-puppet.md index e4a3b392223..5f565c5da2a 100644 --- a/docs/configuring-playbook-appservice-double-puppet.md +++ b/docs/configuring-playbook-appservice-double-puppet.md @@ -27,9 +27,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-appservice-draupnir-for-all.md b/docs/configuring-playbook-appservice-draupnir-for-all.md index be13c93a3fe..18eadcfa839 100644 --- a/docs/configuring-playbook-appservice-draupnir-for-all.md +++ b/docs/configuring-playbook-appservice-draupnir-for-all.md @@ -60,9 +60,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-backup-borg.md b/docs/configuring-playbook-backup-borg.md index 07fc3080ff1..abe8a55c74e 100644 --- a/docs/configuring-playbook-backup-borg.md +++ b/docs/configuring-playbook-backup-borg.md @@ -78,9 +78,9 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## Manually start a backup diff --git a/docs/configuring-playbook-bot-baibot.md b/docs/configuring-playbook-bot-baibot.md index 423fcf16bb9..74d89eaadb8 100644 --- a/docs/configuring-playbook-bot-baibot.md +++ b/docs/configuring-playbook-bot-baibot.md @@ -387,9 +387,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. - 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. diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md index c1c00ecbe5e..7790558fd1b 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -67,9 +67,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. - 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. diff --git a/docs/configuring-playbook-bot-chatgpt.md b/docs/configuring-playbook-bot-chatgpt.md index e892f2ea225..401fb9799d9 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -67,9 +67,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index 7f34158d882..c3a57d5633d 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -126,9 +126,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. - If you change the Pantalaimon's password (`matrix_bot_draupnir_pantalaimon_password` in your `vars.yml` file) subsequently, its credentials on the homeserver won't be updated automatically. If you'd like to change the password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_draupnir_pantalaimon_password` to let Pantalaimon know its new password. diff --git a/docs/configuring-playbook-bot-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index 42cbcdc98d1..850fbbca52a 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -230,9 +230,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bot-honoroit.md b/docs/configuring-playbook-bot-honoroit.md index bf210dc029f..acf340ce61e 100644 --- a/docs/configuring-playbook-bot-honoroit.md +++ b/docs/configuring-playbook-bot-honoroit.md @@ -59,9 +59,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. - 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. diff --git a/docs/configuring-playbook-bot-matrix-registration-bot.md b/docs/configuring-playbook-bot-matrix-registration-bot.md index ef846f33fd3..3d4d7efabdf 100644 --- a/docs/configuring-playbook-bot-matrix-registration-bot.md +++ b/docs/configuring-playbook-bot-matrix-registration-bot.md @@ -43,9 +43,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. - If you change the bot password (`matrix_bot_matrix_registration_bot_bot_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_registration_bot_bot_password` to let the bot know its new password. diff --git a/docs/configuring-playbook-bot-matrix-reminder-bot.md b/docs/configuring-playbook-bot-matrix-reminder-bot.md index 8142ac34f55..e7a400fa4f5 100644 --- a/docs/configuring-playbook-bot-matrix-reminder-bot.md +++ b/docs/configuring-playbook-bot-matrix-reminder-bot.md @@ -38,9 +38,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. - 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. diff --git a/docs/configuring-playbook-bot-maubot.md b/docs/configuring-playbook-bot-maubot.md index 45b76f47a12..bcc68b3d69b 100644 --- a/docs/configuring-playbook-bot-maubot.md +++ b/docs/configuring-playbook-bot-maubot.md @@ -60,9 +60,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. - 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. diff --git a/docs/configuring-playbook-bot-mjolnir.md b/docs/configuring-playbook-bot-mjolnir.md index 7d1be0404c9..805c201efcc 100644 --- a/docs/configuring-playbook-bot-mjolnir.md +++ b/docs/configuring-playbook-bot-mjolnir.md @@ -128,9 +128,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. - If you change the Pantalaimon's password (`matrix_bot_mjolnir_pantalaimon_password` in your `vars.yml` file) subsequently, its credentials on the homeserver won't be updated automatically. If you'd like to change the password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_mjolnir_pantalaimon_password` to let Pantalaimon know its new password. diff --git a/docs/configuring-playbook-bridge-appservice-discord.md b/docs/configuring-playbook-bridge-appservice-discord.md index 760782da2b0..b8b73e08bf5 100644 --- a/docs/configuring-playbook-bridge-appservice-discord.md +++ b/docs/configuring-playbook-bridge-appservice-discord.md @@ -41,9 +41,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Self-Service Bridging (Manual) diff --git a/docs/configuring-playbook-bridge-appservice-irc.md b/docs/configuring-playbook-bridge-appservice-irc.md index cbd995e32f0..0a07b858845 100644 --- a/docs/configuring-playbook-bridge-appservice-irc.md +++ b/docs/configuring-playbook-bridge-appservice-irc.md @@ -73,9 +73,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-appservice-kakaotalk.md b/docs/configuring-playbook-bridge-appservice-kakaotalk.md index 4a85b2aed00..34e42bc5292 100644 --- a/docs/configuring-playbook-bridge-appservice-kakaotalk.md +++ b/docs/configuring-playbook-bridge-appservice-kakaotalk.md @@ -44,9 +44,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-appservice-slack.md b/docs/configuring-playbook-bridge-appservice-slack.md index 85196e189e6..db29213152b 100644 --- a/docs/configuring-playbook-bridge-appservice-slack.md +++ b/docs/configuring-playbook-bridge-appservice-slack.md @@ -76,9 +76,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-appservice-webhooks.md b/docs/configuring-playbook-bridge-appservice-webhooks.md index a937e0583d1..e20d3caa659 100644 --- a/docs/configuring-playbook-bridge-appservice-webhooks.md +++ b/docs/configuring-playbook-bridge-appservice-webhooks.md @@ -37,9 +37,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-beeper-linkedin.md b/docs/configuring-playbook-bridge-beeper-linkedin.md index 58fd43640b3..24b68915273 100644 --- a/docs/configuring-playbook-bridge-beeper-linkedin.md +++ b/docs/configuring-playbook-bridge-beeper-linkedin.md @@ -46,9 +46,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## 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 03b20989d57..c962421858a 100644 --- a/docs/configuring-playbook-bridge-go-skype-bridge.md +++ b/docs/configuring-playbook-bridge-go-skype-bridge.md @@ -25,9 +25,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-heisenbridge.md b/docs/configuring-playbook-bridge-heisenbridge.md index 96b7ca2f2c7..b85fab58502 100644 --- a/docs/configuring-playbook-bridge-heisenbridge.md +++ b/docs/configuring-playbook-bridge-heisenbridge.md @@ -60,9 +60,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-matrix-bridge-sms.md b/docs/configuring-playbook-bridge-matrix-bridge-sms.md index 25103d75342..d445ee0e7e9 100644 --- a/docs/configuring-playbook-bridge-matrix-bridge-sms.md +++ b/docs/configuring-playbook-bridge-matrix-bridge-sms.md @@ -44,9 +44,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-discord.md b/docs/configuring-playbook-bridge-mautrix-discord.md index 0f72110bb61..39152d26060 100644 --- a/docs/configuring-playbook-bridge-mautrix-discord.md +++ b/docs/configuring-playbook-bridge-mautrix-discord.md @@ -53,9 +53,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-facebook.md b/docs/configuring-playbook-bridge-mautrix-facebook.md index 8e41db1c6de..848c1c64ae3 100644 --- a/docs/configuring-playbook-bridge-mautrix-facebook.md +++ b/docs/configuring-playbook-bridge-mautrix-facebook.md @@ -66,9 +66,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-gmessages.md b/docs/configuring-playbook-bridge-mautrix-gmessages.md index c26b6e57e7a..e9a4fbc8bdd 100644 --- a/docs/configuring-playbook-bridge-mautrix-gmessages.md +++ b/docs/configuring-playbook-bridge-mautrix-gmessages.md @@ -31,9 +31,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-googlechat.md b/docs/configuring-playbook-bridge-mautrix-googlechat.md index 4c368f2b92a..3cc73bae843 100644 --- a/docs/configuring-playbook-bridge-mautrix-googlechat.md +++ b/docs/configuring-playbook-bridge-mautrix-googlechat.md @@ -31,9 +31,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-hangouts.md b/docs/configuring-playbook-bridge-mautrix-hangouts.md index fb64ed097a7..83aa016f7c9 100644 --- a/docs/configuring-playbook-bridge-mautrix-hangouts.md +++ b/docs/configuring-playbook-bridge-mautrix-hangouts.md @@ -33,9 +33,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-instagram.md b/docs/configuring-playbook-bridge-mautrix-instagram.md index 25a7b7d8b37..d57b9346f6c 100644 --- a/docs/configuring-playbook-bridge-mautrix-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-instagram.md @@ -53,9 +53,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md index cd70a8c4251..1c1f1e79341 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md @@ -79,9 +79,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md index 7883ebc9dca..4ac22d22761 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md @@ -93,9 +93,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-signal.md b/docs/configuring-playbook-bridge-mautrix-signal.md index 561bfac2ad5..dea39e730a4 100644 --- a/docs/configuring-playbook-bridge-mautrix-signal.md +++ b/docs/configuring-playbook-bridge-mautrix-signal.md @@ -79,9 +79,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-slack.md b/docs/configuring-playbook-bridge-mautrix-slack.md index 17520264427..167223d6054 100644 --- a/docs/configuring-playbook-bridge-mautrix-slack.md +++ b/docs/configuring-playbook-bridge-mautrix-slack.md @@ -55,9 +55,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-telegram.md b/docs/configuring-playbook-bridge-mautrix-telegram.md index 7b7d7318227..b97fcbe770a 100644 --- a/docs/configuring-playbook-bridge-mautrix-telegram.md +++ b/docs/configuring-playbook-bridge-mautrix-telegram.md @@ -33,9 +33,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-twitter.md b/docs/configuring-playbook-bridge-mautrix-twitter.md index 6bde13c5a8e..93eaadb160e 100644 --- a/docs/configuring-playbook-bridge-mautrix-twitter.md +++ b/docs/configuring-playbook-bridge-mautrix-twitter.md @@ -33,9 +33,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-whatsapp.md b/docs/configuring-playbook-bridge-mautrix-whatsapp.md index 35adeb85cfe..a70f40d213b 100644 --- a/docs/configuring-playbook-bridge-mautrix-whatsapp.md +++ b/docs/configuring-playbook-bridge-mautrix-whatsapp.md @@ -47,9 +47,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mautrix-wsproxy.md b/docs/configuring-playbook-bridge-mautrix-wsproxy.md index ff9ff624685..a7363c190b8 100644 --- a/docs/configuring-playbook-bridge-mautrix-wsproxy.md +++ b/docs/configuring-playbook-bridge-mautrix-wsproxy.md @@ -52,9 +52,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mx-puppet-discord.md b/docs/configuring-playbook-bridge-mx-puppet-discord.md index 3ab1b2ccf19..b886f206be5 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-discord.md +++ b/docs/configuring-playbook-bridge-mx-puppet-discord.md @@ -29,9 +29,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mx-puppet-groupme.md b/docs/configuring-playbook-bridge-mx-puppet-groupme.md index ee0cf065ae8..3b928dd263d 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-groupme.md +++ b/docs/configuring-playbook-bridge-mx-puppet-groupme.md @@ -25,9 +25,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mx-puppet-instagram.md b/docs/configuring-playbook-bridge-mx-puppet-instagram.md index 3368dd57918..da75cbb0cb9 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-instagram.md +++ b/docs/configuring-playbook-bridge-mx-puppet-instagram.md @@ -25,9 +25,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mx-puppet-slack.md b/docs/configuring-playbook-bridge-mx-puppet-slack.md index 4cb19d1b67a..c9888729ecb 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-slack.md +++ b/docs/configuring-playbook-bridge-mx-puppet-slack.md @@ -34,9 +34,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mx-puppet-steam.md b/docs/configuring-playbook-bridge-mx-puppet-steam.md index 56e37f714b0..5ab9655aec9 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-steam.md +++ b/docs/configuring-playbook-bridge-mx-puppet-steam.md @@ -25,9 +25,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-mx-puppet-twitter.md b/docs/configuring-playbook-bridge-mx-puppet-twitter.md index 11024cf8206..5d43b44b02a 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-twitter.md +++ b/docs/configuring-playbook-bridge-mx-puppet-twitter.md @@ -36,9 +36,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-bridge-postmoogle.md b/docs/configuring-playbook-bridge-postmoogle.md index d7e96d1d7ab..5b13a6719d2 100644 --- a/docs/configuring-playbook-bridge-postmoogle.md +++ b/docs/configuring-playbook-bridge-postmoogle.md @@ -60,9 +60,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. - 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. diff --git a/docs/configuring-playbook-bridge-wechat.md b/docs/configuring-playbook-bridge-wechat.md index 5663904a1ca..98451bf00d8 100644 --- a/docs/configuring-playbook-bridge-wechat.md +++ b/docs/configuring-playbook-bridge-wechat.md @@ -25,9 +25,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-cactus-comments.md b/docs/configuring-playbook-cactus-comments.md index 6a3dd3f8de6..e39da3292c0 100644 --- a/docs/configuring-playbook-cactus-comments.md +++ b/docs/configuring-playbook-cactus-comments.md @@ -74,9 +74,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Usage diff --git a/docs/configuring-playbook-client-cinny.md b/docs/configuring-playbook-client-cinny.md index 513cc7f6a5f..f4d02eefc9a 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-client-element-web.md b/docs/configuring-playbook-client-element-web.md index f410459e3b1..deae92db185 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-client-hydrogen.md b/docs/configuring-playbook-client-hydrogen.md index 600fc3b95cc..f63bf4eeafd 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-client-schildichat-web.md b/docs/configuring-playbook-client-schildichat-web.md index a5ae5b2b71e..670699d7c6e 100644 --- a/docs/configuring-playbook-client-schildichat-web.md +++ b/docs/configuring-playbook-client-schildichat-web.md @@ -74,6 +74,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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-dendrite.md b/docs/configuring-playbook-dendrite.md index 31d43c0e291..fd640cca043 100644 --- a/docs/configuring-playbook-dendrite.md +++ b/docs/configuring-playbook-dendrite.md @@ -41,6 +41,6 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-dimension.md b/docs/configuring-playbook-dimension.md index 80645bcefef..8544aa8cf4c 100644 --- a/docs/configuring-playbook-dimension.md +++ b/docs/configuring-playbook-dimension.md @@ -78,9 +78,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start **Notes**: -- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` +- The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all` - `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) + `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. Note these shortcuts run the `ensure-matrix-users-created` tag too. - After Dimension has been installed you may need to log out and log back in for it to pick up the new integration manager. Then you can access integrations in Element Web by opening a room, clicking the Room info button (`i`) button in the top right corner of the screen, and then clicking Add widgets, bridges & bots. diff --git a/docs/configuring-playbook-dynamic-dns.md b/docs/configuring-playbook-dynamic-dns.md index e610f3b5feb..48b0e6b61e8 100644 --- a/docs/configuring-playbook-dynamic-dns.md +++ b/docs/configuring-playbook-dynamic-dns.md @@ -32,9 +32,9 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## Additional Reading diff --git a/docs/configuring-playbook-email2matrix.md b/docs/configuring-playbook-email2matrix.md index 5b0bcd4fae7..638ce468c90 100644 --- a/docs/configuring-playbook-email2matrix.md +++ b/docs/configuring-playbook-email2matrix.md @@ -91,8 +91,8 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-email2matrix,start **Notes**: -- The shortcut commands with `just` program are also available: `just run-tags setup-email2matrix,start` or `just run-tags setup-all,start` +- The shortcut commands with the [`just` program](just.md) are also available: `just run-tags setup-email2matrix,start` or `just setup-all` - `just run-tags setup-email2matrix,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + `just run-tags setup-email2matrix,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note `just setup-all` runs the `ensure-matrix-users-created` tag too. - After installation, you may wish to send a test email to the email address assigned to `mailbox1` (default: `mailbox1@matrix.example.com`) to make sure that Email2Matrix works as expected. diff --git a/docs/configuring-playbook-etherpad.md b/docs/configuring-playbook-etherpad.md index 50ca562ed0f..a1d06d8d040 100644 --- a/docs/configuring-playbook-etherpad.md +++ b/docs/configuring-playbook-etherpad.md @@ -55,9 +55,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all` - `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) + `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. - If you change the Etherpad admin user's password (`etherpad_admin_password` in your `vars.yml` file) subsequently, the admin user's credentials on the homeserver won't be updated automatically. If you'd like to change the admin user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `etherpad_admin_password` to let the admin user know its new password. diff --git a/docs/configuring-playbook-jitsi.md b/docs/configuring-playbook-jitsi.md index 9ea3fb9e63d..fa560b8449f 100644 --- a/docs/configuring-playbook-jitsi.md +++ b/docs/configuring-playbook-jitsi.md @@ -276,9 +276,9 @@ 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## Usage diff --git a/docs/configuring-playbook-ma1sd.md b/docs/configuring-playbook-ma1sd.md index 42408aaed20..36485dcafe0 100644 --- a/docs/configuring-playbook-ma1sd.md +++ b/docs/configuring-playbook-ma1sd.md @@ -138,9 +138,9 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## Troubleshooting diff --git a/docs/configuring-playbook-matrix-authentication-service.md b/docs/configuring-playbook-matrix-authentication-service.md index 276c334fccd..d3cfdd314e1 100644 --- a/docs/configuring-playbook-matrix-authentication-service.md +++ b/docs/configuring-playbook-matrix-authentication-service.md @@ -297,9 +297,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start **Notes**: -- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` +- The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all` - `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) + `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. Note these shortcuts run the `ensure-matrix-users-created` tag too. - If you're in the process of migrating an existing Synapse homeserver to MAS, you should now follow the rest of the steps in the [Migrating an existing Synapse homeserver to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service) guide. diff --git a/docs/configuring-playbook-matrix-corporal.md b/docs/configuring-playbook-matrix-corporal.md index 3127ea701d0..6b04c4bcdee 100644 --- a/docs/configuring-playbook-matrix-corporal.md +++ b/docs/configuring-playbook-matrix-corporal.md @@ -123,9 +123,9 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` -The shortcut commands with `just` program are also available: `just run-tags setup-aux-files,setup-corporal,start` or `just run-tags setup-all,start` +The shortcut commands with the [`just` program](just.md) are also available: `just run-tags setup-aux-files,setup-corporal,start` or `just setup-all` -`just run-tags setup-aux-files,setup-corporal,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) +`just run-tags setup-aux-files,setup-corporal,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note `just setup-all` runs the `ensure-matrix-users-created` tag too. ## Matrix Corporal files diff --git a/docs/configuring-playbook-matrix-ldap-registration-proxy.md b/docs/configuring-playbook-matrix-ldap-registration-proxy.md index 02b04edf976..f38fd62a872 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 it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-matrix-registration.md b/docs/configuring-playbook-matrix-registration.md index 3308d273ee3..1e8b4305d4f 100644 --- a/docs/configuring-playbook-matrix-registration.md +++ b/docs/configuring-playbook-matrix-registration.md @@ -59,9 +59,9 @@ 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## Usage diff --git a/docs/configuring-playbook-mautrix-bridges.md b/docs/configuring-playbook-mautrix-bridges.md index 99b9974d73c..8191e799b5c 100644 --- a/docs/configuring-playbook-mautrix-bridges.md +++ b/docs/configuring-playbook-mautrix-bridges.md @@ -104,9 +104,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use - 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` +- The shortcut commands with the [`just` program](just.md) 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. ## Set up Double Puppeting diff --git a/docs/configuring-playbook-ntfy.md b/docs/configuring-playbook-ntfy.md index dab0162078b..ee96d1813dd 100644 --- a/docs/configuring-playbook-ntfy.md +++ b/docs/configuring-playbook-ntfy.md @@ -57,9 +57,9 @@ 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## Usage diff --git a/docs/configuring-playbook-pantalaimon.md b/docs/configuring-playbook-pantalaimon.md index 5b0478a9233..8b0d5458912 100644 --- a/docs/configuring-playbook-pantalaimon.md +++ b/docs/configuring-playbook-pantalaimon.md @@ -25,6 +25,6 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-postgres-backup.md b/docs/configuring-playbook-postgres-backup.md index 9d3967cbcdb..7204387f0ea 100644 --- a/docs/configuring-playbook-postgres-backup.md +++ b/docs/configuring-playbook-postgres-backup.md @@ -36,6 +36,6 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index ae9ec582b81..7b63ebf1a21 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -62,9 +62,9 @@ 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## What does it do? diff --git a/docs/configuring-playbook-prometheus-nginxlog.md b/docs/configuring-playbook-prometheus-nginxlog.md index c3c6081dd59..296fad12195 100644 --- a/docs/configuring-playbook-prometheus-nginxlog.md +++ b/docs/configuring-playbook-prometheus-nginxlog.md @@ -29,9 +29,9 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## Docker Image Compatibility diff --git a/docs/configuring-playbook-prometheus-postgres.md b/docs/configuring-playbook-prometheus-postgres.md index 7d71b1c338f..019eb5a6576 100644 --- a/docs/configuring-playbook-prometheus-postgres.md +++ b/docs/configuring-playbook-prometheus-postgres.md @@ -19,9 +19,9 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## What does it do? diff --git a/docs/configuring-playbook-rageshake.md b/docs/configuring-playbook-rageshake.md index b74eaeefd38..292c17e5f26 100644 --- a/docs/configuring-playbook-rageshake.md +++ b/docs/configuring-playbook-rageshake.md @@ -58,9 +58,9 @@ 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## Usage diff --git a/docs/configuring-playbook-rest-auth.md b/docs/configuring-playbook-rest-auth.md index 224978ba658..2a22841c54d 100644 --- a/docs/configuring-playbook-rest-auth.md +++ b/docs/configuring-playbook-rest-auth.md @@ -33,6 +33,6 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-riot-web.md b/docs/configuring-playbook-riot-web.md index ecc4e588f67..95a89ccd047 100644 --- a/docs/configuring-playbook-riot-web.md +++ b/docs/configuring-playbook-riot-web.md @@ -37,6 +37,6 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-shared-secret-auth.md b/docs/configuring-playbook-shared-secret-auth.md index 4d702704cad..fb63001e4a9 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 it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-sliding-sync-proxy.md b/docs/configuring-playbook-sliding-sync-proxy.md index 491df75baf5..51a53df030c 100644 --- a/docs/configuring-playbook-sliding-sync-proxy.md +++ b/docs/configuring-playbook-sliding-sync-proxy.md @@ -46,9 +46,9 @@ 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ### External databases diff --git a/docs/configuring-playbook-sygnal.md b/docs/configuring-playbook-sygnal.md index af1101c02de..fc16c7911c5 100644 --- a/docs/configuring-playbook-sygnal.md +++ b/docs/configuring-playbook-sygnal.md @@ -84,9 +84,9 @@ 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## Usage diff --git a/docs/configuring-playbook-synapse-admin.md b/docs/configuring-playbook-synapse-admin.md index a6b52fa9c0e..ba33d177ce6 100644 --- a/docs/configuring-playbook-synapse-admin.md +++ b/docs/configuring-playbook-synapse-admin.md @@ -55,9 +55,9 @@ 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## Usage diff --git a/docs/configuring-playbook-synapse-auto-compressor.md b/docs/configuring-playbook-synapse-auto-compressor.md index 94c85c76bad..0e07ad1c76e 100644 --- a/docs/configuring-playbook-synapse-auto-compressor.md +++ b/docs/configuring-playbook-synapse-auto-compressor.md @@ -25,9 +25,9 @@ After configuring the playbook, run it with [playbook tags](playbook-tags.md) as 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. ## Usage diff --git a/docs/configuring-playbook-synapse-usage-exporter.md b/docs/configuring-playbook-synapse-usage-exporter.md index 996ee2f0379..0526becf5d7 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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all` -`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) +`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. Note these shortcuts run the `ensure-matrix-users-created` tag too. diff --git a/docs/configuring-playbook-user-verification-service.md b/docs/configuring-playbook-user-verification-service.md index 0e103102865..12ece9f02c5 100644 --- a/docs/configuring-playbook-user-verification-service.md +++ b/docs/configuring-playbook-user-verification-service.md @@ -96,9 +96,9 @@ After these variables have been set, run the playbook with [playbook tags](playb 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 the [`just` program](just.md) are also available: `just run-tags setup-matrix-user-verification-service,start` or `just setup-all` -`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) +`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 setup-all`, or these components will still remain installed. Note `just setup-all` runs the `ensure-matrix-users-created` tag too. ## Logging diff --git a/docs/faq.md b/docs/faq.md index 28360486832..aaf1ec3620f 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -278,9 +278,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start **Notes**: -- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` +- The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all` - `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) + `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. Note these shortcuts run the `ensure-matrix-users-created` tag too. - Without setting up [server delegation](howto-server-delegation.md) to `matrix.example.com`, your user identifiers will be like `@user:matrix.example.com`. This is equivalent to having an email address like `bob@mail.company.com`, instead of just `bob@company.com`. diff --git a/docs/installing.md b/docs/installing.md index f6c83bd6690..0abfe068218 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -142,4 +142,18 @@ Since it is unsafe to keep outdated services running on the server connected to For more information about upgrading or maintaining services with the playbook, take at look at this page: [Upgrading the Matrix services](maintenance-upgrading-services.md) -Feel free to **re-run the setup command any time** you think something is off with the server configuration. Ansible will take your configuration and update your server to match. +Feel free to **re-run the setup command any time** you think something is wrong with the server configuration. Ansible will take your configuration and update your server to match. + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Note**: see [this page on the playbook tags](playbook-tags.md) for more information about those tags. + +### Make full use of `just` shortcut commands + +After you get familiar with reconfiguring and re-running the playbook to maintain the server, upgrade its services, etc., you probably would like to make use of `just` shortcut commands for faster input. + +For example, `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. + +You can learn about the shortcut commands on this page: [Running `just` commands](just.md) diff --git a/docs/maintenance-upgrading-services.md b/docs/maintenance-upgrading-services.md index 57aa80ddaa7..a59bf59403d 100644 --- a/docs/maintenance-upgrading-services.md +++ b/docs/maintenance-upgrading-services.md @@ -37,11 +37,21 @@ After updating the Ansible roles, then re-run the [playbook setup](installing.md ansible-playbook -i inventory/hosts setup.yml --tags=install-all,start ``` -If you remove components from `vars.yml`, or if we switch some component from being installed by default to not being installed by default anymore, you'd need to run the setup command with `--tags=setup-all` instead of `--tags=install-all`. See [this page on the playbook tags](playbook-tags.md) for more information. +If you remove components from `vars.yml`, or if we switch some component from being installed by default to not being installed by default anymore, you'd need to run the setup command with the `setup-all` tag as below: -#### Run `just` to execute shortcut command +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account, if any. + +- The shortcut commands with the [`just` program](just.md) 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. Note these shortcuts run the `ensure-matrix-users-created` tag too. -If you want to invoke the `ansible-playbook` command with less typing, you can run `just` to execute the shortcut command: `just install-all` (or `just setup-all`). Note that it restarts all services automatically. +- See [this page on the playbook tags](playbook-tags.md) for more information about those tags. ## PostgreSQL major version upgrade diff --git a/docs/quick-start.md b/docs/quick-start.md index b08af651470..11d8cb7d4f0 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -177,7 +177,13 @@ ansible-playbook -i inventory/hosts setup.yml --tags=install-matrix-static-files After the command finishes, you can also check whether your server federates with the Matrix network by using the [Federation Tester](https://federationtester.matrix.org/) against your base domain (`example.com`), not the `matrix.example.com` subdomain. -If you think something is off with the server configuration, feel free to [re-run the full setup command](#run-the-installation-command) any time. +### Re-run the full setup command any time + +If you think something is wrong with the server configuration, feel free to re-run the setup command any time: + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start +``` ## Log in to your user account diff --git a/docs/registering-users.md b/docs/registering-users.md index 1633f162abd..592d88b935a 100644 --- a/docs/registering-users.md +++ b/docs/registering-users.md @@ -121,9 +121,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start **Notes**: -- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start` +- The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all` - `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) + `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. Note these shortcuts run the `ensure-matrix-users-created` tag too. - If you're opening up registrations publicly like this, you might also wish to [configure CAPTCHA protection](configuring-captcha.md).