diff --git a/docs/configuring-playbook-alertmanager-receiver.md b/docs/configuring-playbook-alertmanager-receiver.md index 0784b80e1..882a4ea5a 100644 --- a/docs/configuring-playbook-alertmanager-receiver.md +++ b/docs/configuring-playbook-alertmanager-receiver.md @@ -83,6 +83,10 @@ Now that you've [prepared the bot account and room](#account-and-room-preparatio ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + Then, you can proceed to [Usage](#usage). diff --git a/docs/configuring-playbook-appservice-double-puppet.md b/docs/configuring-playbook-appservice-double-puppet.md index 07d8b7411..beacf9b5c 100644 --- a/docs/configuring-playbook-appservice-double-puppet.md +++ b/docs/configuring-playbook-appservice-double-puppet.md @@ -23,6 +23,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage When enabled, double puppeting will automatically be enabled for all bridges that support double puppeting via the appservice method. diff --git a/docs/configuring-playbook-appservice-draupnir-for-all.md b/docs/configuring-playbook-appservice-draupnir-for-all.md index 5c172db5d..9b2725e0d 100644 --- a/docs/configuring-playbook-appservice-draupnir-for-all.md +++ b/docs/configuring-playbook-appservice-draupnir-for-all.md @@ -56,6 +56,9 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-backup-borg.md b/docs/configuring-playbook-backup-borg.md index 58b884394..e26f6ad1a 100644 --- a/docs/configuring-playbook-backup-borg.md +++ b/docs/configuring-playbook-backup-borg.md @@ -78,6 +78,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just 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) + ## Manually start a backup For testing your setup it can be helpful to not wait until 4am. If you want to run the backup immediately, log onto the server and run `systemctl start matrix-backup-borg`. This will not return until the backup is done, so possibly a long time. Consider using [tmux](https://en.wikipedia.org/wiki/Tmux) if your SSH connection is unstable. diff --git a/docs/configuring-playbook-bot-baibot.md b/docs/configuring-playbook-bot-baibot.md index cec99b14f..5156c4a5f 100644 --- a/docs/configuring-playbook-bot-baibot.md +++ b/docs/configuring-playbook-bot-baibot.md @@ -383,6 +383,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + **Notes**: - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md index b03e3777b..2e0f55d6e 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -63,6 +63,10 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + **Notes**: - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account diff --git a/docs/configuring-playbook-bot-chatgpt.md b/docs/configuring-playbook-bot-chatgpt.md index f4fa36b9e..d3b6248a5 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -63,6 +63,9 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index b2e757a51..7d7170f14 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -122,6 +122,9 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bot-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index 7ce833d13..816d1a438 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -226,6 +226,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 install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bot-honoroit.md b/docs/configuring-playbook-bot-honoroit.md index ae956bd95..8f334dd79 100644 --- a/docs/configuring-playbook-bot-honoroit.md +++ b/docs/configuring-playbook-bot-honoroit.md @@ -55,6 +55,10 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + **Notes**: - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account diff --git a/docs/configuring-playbook-bot-matrix-registration-bot.md b/docs/configuring-playbook-bot-matrix-registration-bot.md index 05d5c83a1..a3f4e5ba7 100644 --- a/docs/configuring-playbook-bot-matrix-registration-bot.md +++ b/docs/configuring-playbook-bot-matrix-registration-bot.md @@ -39,6 +39,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage To use the bot, start a chat with `@bot.matrix-registration-bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bot-matrix-reminder-bot.md b/docs/configuring-playbook-bot-matrix-reminder-bot.md index 2c4dfa4f2..db79e86f0 100644 --- a/docs/configuring-playbook-bot-matrix-reminder-bot.md +++ b/docs/configuring-playbook-bot-matrix-reminder-bot.md @@ -34,6 +34,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + **Notes**: - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account diff --git a/docs/configuring-playbook-bot-maubot.md b/docs/configuring-playbook-bot-maubot.md index f2f4c2740..e7f0a0074 100644 --- a/docs/configuring-playbook-bot-maubot.md +++ b/docs/configuring-playbook-bot-maubot.md @@ -56,6 +56,10 @@ 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 install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + **Notes**: - 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 f903f6734..72068c704 100644 --- a/docs/configuring-playbook-bot-mjolnir.md +++ b/docs/configuring-playbook-bot-mjolnir.md @@ -124,6 +124,9 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-bridge-appservice-discord.md b/docs/configuring-playbook-bridge-appservice-discord.md index 6f530aa8a..ee147a4ee 100644 --- a/docs/configuring-playbook-bridge-appservice-discord.md +++ b/docs/configuring-playbook-bridge-appservice-discord.md @@ -37,6 +37,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Self-Service Bridging (Manual) Self-service bridging allows you to bridge specific and existing Matrix rooms to specific Discord rooms. To enable it, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: diff --git a/docs/configuring-playbook-bridge-appservice-irc.md b/docs/configuring-playbook-bridge-appservice-irc.md index 282602d13..fce896483 100644 --- a/docs/configuring-playbook-bridge-appservice-irc.md +++ b/docs/configuring-playbook-bridge-appservice-irc.md @@ -69,6 +69,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage You then need to start a chat with `@irc_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-appservice-kakaotalk.md b/docs/configuring-playbook-bridge-appservice-kakaotalk.md index 4ec7e8a5a..eb920c5f5 100644 --- a/docs/configuring-playbook-bridge-appservice-kakaotalk.md +++ b/docs/configuring-playbook-bridge-appservice-kakaotalk.md @@ -40,6 +40,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Start a chat with `@kakaotalkbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-appservice-slack.md b/docs/configuring-playbook-bridge-appservice-slack.md index 974fc10bc..4b16ef33e 100644 --- a/docs/configuring-playbook-bridge-appservice-slack.md +++ b/docs/configuring-playbook-bridge-appservice-slack.md @@ -72,6 +72,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Send `/invite @slackbot:example.com` to invite the bridge bot user into the admin room. diff --git a/docs/configuring-playbook-bridge-appservice-webhooks.md b/docs/configuring-playbook-bridge-appservice-webhooks.md index 7e926a2a8..c3e64e323 100644 --- a/docs/configuring-playbook-bridge-appservice-webhooks.md +++ b/docs/configuring-playbook-bridge-appservice-webhooks.md @@ -33,6 +33,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Invite the bridge bot user to your room in either way. diff --git a/docs/configuring-playbook-bridge-beeper-linkedin.md b/docs/configuring-playbook-bridge-beeper-linkedin.md index 33f09d923..47df9eec3 100644 --- a/docs/configuring-playbook-bridge-beeper-linkedin.md +++ b/docs/configuring-playbook-bridge-beeper-linkedin.md @@ -42,6 +42,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Set up Double Puppeting by enabling Appservice Double Puppet or Shared Secret Auth The bridge automatically performs Double Puppeting if [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) or [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook. diff --git a/docs/configuring-playbook-bridge-go-skype-bridge.md b/docs/configuring-playbook-bridge-go-skype-bridge.md index 136c663dd..a099eeeff 100644 --- a/docs/configuring-playbook-bridge-go-skype-bridge.md +++ b/docs/configuring-playbook-bridge-go-skype-bridge.md @@ -21,6 +21,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Once the bot is enabled, you need to start a chat with `Skype bridge bot` with the handle `@skypebridgebot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-heisenbridge.md b/docs/configuring-playbook-bridge-heisenbridge.md index b08ce6902..63cedcb8f 100644 --- a/docs/configuring-playbook-bridge-heisenbridge.md +++ b/docs/configuring-playbook-bridge-heisenbridge.md @@ -56,6 +56,10 @@ 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 install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage After the bridge is successfully running just DM `@heisenbridge:example.com` to start setting it up. If the bridge ignores you and a DM is not accepted then the owner setting may be wrong. diff --git a/docs/configuring-playbook-bridge-matrix-bridge-sms.md b/docs/configuring-playbook-bridge-matrix-bridge-sms.md index 0bf9ad5c3..47569685d 100644 --- a/docs/configuring-playbook-bridge-matrix-bridge-sms.md +++ b/docs/configuring-playbook-bridge-matrix-bridge-sms.md @@ -40,6 +40,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Read the [user guide](https://github.com/benkuly/matrix-sms-bridge/blob/master/README.md#user-guide) to see how this bridge works. diff --git a/docs/configuring-playbook-bridge-mautrix-discord.md b/docs/configuring-playbook-bridge-mautrix-discord.md index 62735d8a0..b4dabd2e8 100644 --- a/docs/configuring-playbook-bridge-mautrix-discord.md +++ b/docs/configuring-playbook-bridge-mautrix-discord.md @@ -49,6 +49,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage ### Logging in diff --git a/docs/configuring-playbook-bridge-mautrix-facebook.md b/docs/configuring-playbook-bridge-mautrix-facebook.md index d8dee1c84..a266ab37d 100644 --- a/docs/configuring-playbook-bridge-mautrix-facebook.md +++ b/docs/configuring-playbook-bridge-mautrix-facebook.md @@ -62,6 +62,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage You then need to start a chat with `@facebookbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-gmessages.md b/docs/configuring-playbook-bridge-mautrix-gmessages.md index 3325d135a..5ee0edd23 100644 --- a/docs/configuring-playbook-bridge-mautrix-gmessages.md +++ b/docs/configuring-playbook-bridge-mautrix-gmessages.md @@ -27,6 +27,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage You then need to start a chat with `@gmessagesbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-googlechat.md b/docs/configuring-playbook-bridge-mautrix-googlechat.md index 87b5dfcfd..3eadaa1e3 100644 --- a/docs/configuring-playbook-bridge-mautrix-googlechat.md +++ b/docs/configuring-playbook-bridge-mautrix-googlechat.md @@ -27,6 +27,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Once the bot is enabled you need to start a chat with `googlechat bridge bot` with handle `@googlechatbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-hangouts.md b/docs/configuring-playbook-bridge-mautrix-hangouts.md index f64f9bbaa..059e72d0a 100644 --- a/docs/configuring-playbook-bridge-mautrix-hangouts.md +++ b/docs/configuring-playbook-bridge-mautrix-hangouts.md @@ -29,6 +29,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Once the bot is enabled you need to start a chat with `Hangouts bridge bot` with handle `@hangoutsbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-instagram.md b/docs/configuring-playbook-bridge-mautrix-instagram.md index c6e32d1e8..5470c518e 100644 --- a/docs/configuring-playbook-bridge-mautrix-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-instagram.md @@ -49,6 +49,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage You then need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md index 4fd0c15b8..d555901f0 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-instagram.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-instagram.md @@ -75,6 +75,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage You then need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md index 4495c195f..7d1e41754 100644 --- a/docs/configuring-playbook-bridge-mautrix-meta-messenger.md +++ b/docs/configuring-playbook-bridge-mautrix-meta-messenger.md @@ -89,6 +89,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage You then need to start a chat with `@messengerbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). Note that the user ID of the bridge's bot is not `@facebookbot:example.com`. diff --git a/docs/configuring-playbook-bridge-mautrix-signal.md b/docs/configuring-playbook-bridge-mautrix-signal.md index b0a38371a..a7932a6ea 100644 --- a/docs/configuring-playbook-bridge-mautrix-signal.md +++ b/docs/configuring-playbook-bridge-mautrix-signal.md @@ -75,6 +75,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage You then need to start a chat with `@signalbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-slack.md b/docs/configuring-playbook-bridge-mautrix-slack.md index 00ed13fc2..ab2d91c03 100644 --- a/docs/configuring-playbook-bridge-mautrix-slack.md +++ b/docs/configuring-playbook-bridge-mautrix-slack.md @@ -51,6 +51,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage 1. Start a chat with `@slackbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-telegram.md b/docs/configuring-playbook-bridge-mautrix-telegram.md index 0e84079af..8216cfb79 100644 --- a/docs/configuring-playbook-bridge-mautrix-telegram.md +++ b/docs/configuring-playbook-bridge-mautrix-telegram.md @@ -29,6 +29,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage You then need to start a chat with `@telegrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-twitter.md b/docs/configuring-playbook-bridge-mautrix-twitter.md index 1d141cc18..49b1446ec 100644 --- a/docs/configuring-playbook-bridge-mautrix-twitter.md +++ b/docs/configuring-playbook-bridge-mautrix-twitter.md @@ -29,6 +29,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage 1. You then need to start a chat with `@twitterbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-whatsapp.md b/docs/configuring-playbook-bridge-mautrix-whatsapp.md index 798bb4f0b..3e06756ec 100644 --- a/docs/configuring-playbook-bridge-mautrix-whatsapp.md +++ b/docs/configuring-playbook-bridge-mautrix-whatsapp.md @@ -43,6 +43,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage You then need to start a chat with `@whatsappbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mautrix-wsproxy.md b/docs/configuring-playbook-bridge-mautrix-wsproxy.md index 91413ba31..c61e16880 100644 --- a/docs/configuring-playbook-bridge-mautrix-wsproxy.md +++ b/docs/configuring-playbook-bridge-mautrix-wsproxy.md @@ -48,6 +48,10 @@ 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 install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Follow the [matrix-imessage documenation](https://docs.mau.fi/bridges/go/imessage/index.html) for running `android-sms` and/or `matrix-imessage` on your device(s). diff --git a/docs/configuring-playbook-bridge-mx-puppet-discord.md b/docs/configuring-playbook-bridge-mx-puppet-discord.md index 4fe514502..01c60bdc5 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-discord.md +++ b/docs/configuring-playbook-bridge-mx-puppet-discord.md @@ -25,6 +25,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Once the bot is enabled you need to start a chat with `Discord Puppet Bridge` with the handle `@_discordpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mx-puppet-groupme.md b/docs/configuring-playbook-bridge-mx-puppet-groupme.md index 0b78cdbc3..0079569c6 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-groupme.md +++ b/docs/configuring-playbook-bridge-mx-puppet-groupme.md @@ -21,6 +21,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Once the bot is enabled you need to start a chat with `GroupMe Puppet Bridge` with the handle `@_groupmepuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mx-puppet-instagram.md b/docs/configuring-playbook-bridge-mx-puppet-instagram.md index 74f6c4008..046a3205a 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-instagram.md +++ b/docs/configuring-playbook-bridge-mx-puppet-instagram.md @@ -21,6 +21,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Once the bot is enabled, you need to start a chat with `Instagram Puppet Bridge` with the handle `@_instagrampuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mx-puppet-slack.md b/docs/configuring-playbook-bridge-mx-puppet-slack.md index 91863d118..b21bca468 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-slack.md +++ b/docs/configuring-playbook-bridge-mx-puppet-slack.md @@ -30,6 +30,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Once the bot is enabled you need to start a chat with `Slack Puppet Bridge` with the handle `@_slackpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mx-puppet-steam.md b/docs/configuring-playbook-bridge-mx-puppet-steam.md index 790868112..b21184b34 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-steam.md +++ b/docs/configuring-playbook-bridge-mx-puppet-steam.md @@ -21,6 +21,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Once the bot is enabled you need to start a chat with `Steam Puppet Bridge` with the handle `@_steampuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-mx-puppet-twitter.md b/docs/configuring-playbook-bridge-mx-puppet-twitter.md index be2340acd..070defe3a 100644 --- a/docs/configuring-playbook-bridge-mx-puppet-twitter.md +++ b/docs/configuring-playbook-bridge-mx-puppet-twitter.md @@ -32,6 +32,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Once the bot is enabled you need to start a chat with `Twitter Puppet Bridge` with the handle `@_twitterpuppet_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-bridge-postmoogle.md b/docs/configuring-playbook-bridge-postmoogle.md index e081da60d..03f4f7f5e 100644 --- a/docs/configuring-playbook-bridge-postmoogle.md +++ b/docs/configuring-playbook-bridge-postmoogle.md @@ -56,6 +56,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + **Notes**: - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create a user account of the bridge's bot diff --git a/docs/configuring-playbook-bridge-wechat.md b/docs/configuring-playbook-bridge-wechat.md index ec332e610..6e85021e8 100644 --- a/docs/configuring-playbook-bridge-wechat.md +++ b/docs/configuring-playbook-bridge-wechat.md @@ -21,6 +21,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Once the bridge is installed, start a chat with `@wechatbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). diff --git a/docs/configuring-playbook-cactus-comments.md b/docs/configuring-playbook-cactus-comments.md index 9ec9c88c6..2659deb04 100644 --- a/docs/configuring-playbook-cactus-comments.md +++ b/docs/configuring-playbook-cactus-comments.md @@ -70,6 +70,10 @@ 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 install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage Upon starting Cactus Comments, a `bot.cactusbot` user account is created automatically. diff --git a/docs/configuring-playbook-client-cinny.md b/docs/configuring-playbook-client-cinny.md index 19c563892..e6b1c2e75 100644 --- a/docs/configuring-playbook-client-cinny.md +++ b/docs/configuring-playbook-client-cinny.md @@ -48,3 +48,7 @@ After configuring the playbook and [adjusting your DNS records](#adjusting-dns-r ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-client-element-web.md b/docs/configuring-playbook-client-element-web.md index 8d2ba31a4..3b9450049 100644 --- a/docs/configuring-playbook-client-element-web.md +++ b/docs/configuring-playbook-client-element-web.md @@ -77,3 +77,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-client-hydrogen.md b/docs/configuring-playbook-client-hydrogen.md index 2edaf7b52..c22abed55 100644 --- a/docs/configuring-playbook-client-hydrogen.md +++ b/docs/configuring-playbook-client-hydrogen.md @@ -45,3 +45,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-client-schildichat-web.md b/docs/configuring-playbook-client-schildichat-web.md index ec9f56dde..314983727 100644 --- a/docs/configuring-playbook-client-schildichat-web.md +++ b/docs/configuring-playbook-client-schildichat-web.md @@ -75,3 +75,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-dendrite.md b/docs/configuring-playbook-dendrite.md index 509763265..a41a6586f 100644 --- a/docs/configuring-playbook-dendrite.md +++ b/docs/configuring-playbook-dendrite.md @@ -40,3 +40,7 @@ After configuring the playbook, run the [installation](installing.md) command: ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-dimension.md b/docs/configuring-playbook-dimension.md index a8df49b14..759502732 100644 --- a/docs/configuring-playbook-dimension.md +++ b/docs/configuring-playbook-dimension.md @@ -76,6 +76,10 @@ 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 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) + 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 f0e575bdb..6d81c278f 100644 --- a/docs/configuring-playbook-dynamic-dns.md +++ b/docs/configuring-playbook-dynamic-dns.md @@ -32,6 +32,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just 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) + ## Additional Reading Additional resources: diff --git a/docs/configuring-playbook-etherpad.md b/docs/configuring-playbook-etherpad.md index 6091cfb6d..4aa113faa 100644 --- a/docs/configuring-playbook-etherpad.md +++ b/docs/configuring-playbook-etherpad.md @@ -51,6 +51,10 @@ 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 install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage The Etherpad UI should be available at `https://etherpad.example.com`, while the admin UI (if enabled) should then be available at `https://etherpad.example.com/admin`. diff --git a/docs/configuring-playbook-jitsi.md b/docs/configuring-playbook-jitsi.md index 6c23aaade..01fcaa6c6 100644 --- a/docs/configuring-playbook-jitsi.md +++ b/docs/configuring-playbook-jitsi.md @@ -276,6 +276,10 @@ 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 install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Usage You can use the self-hosted Jitsi server in multiple ways: diff --git a/docs/configuring-playbook-ma1sd.md b/docs/configuring-playbook-ma1sd.md index 9577c6d2b..a4fd06908 100644 --- a/docs/configuring-playbook-ma1sd.md +++ b/docs/configuring-playbook-ma1sd.md @@ -138,6 +138,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just 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) + ## Troubleshooting If email address validation emails sent by ma1sd are not reaching you, you should look into [Adjusting email-sending settings](configuring-playbook-email.md). diff --git a/docs/configuring-playbook-matrix-authentication-service.md b/docs/configuring-playbook-matrix-authentication-service.md index 88c18e029..6a7555cd5 100644 --- a/docs/configuring-playbook-matrix-authentication-service.md +++ b/docs/configuring-playbook-matrix-authentication-service.md @@ -295,6 +295,10 @@ Now that you've [adjusted the playbook configuration](#adjusting-the-playbook-co ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + If you're in the process of migrating an existing Synapse homeserver to MAS, you should now follow the rest of the steps in the [Migrating an existing Synapse homeserver to Matrix Authentication Service](#migrating-an-existing-synapse-homeserver-to-matrix-authentication-service) guide. 💡 After installation, you should [verify that Matrix Authentication Service is installed correctly](#verify-that-matrix-authentication-service-is-installed-correctly). diff --git a/docs/configuring-playbook-matrix-ldap-registration-proxy.md b/docs/configuring-playbook-matrix-ldap-registration-proxy.md index a7e9ffb82..0e463fa58 100644 --- a/docs/configuring-playbook-matrix-ldap-registration-proxy.md +++ b/docs/configuring-playbook-matrix-ldap-registration-proxy.md @@ -40,3 +40,7 @@ After configuring the playbook, run the [installation](installing.md) command: ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-matrix-registration.md b/docs/configuring-playbook-matrix-registration.md index 18d674b60..6e410476b 100644 --- a/docs/configuring-playbook-matrix-registration.md +++ b/docs/configuring-playbook-matrix-registration.md @@ -59,6 +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 install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage @@ -92,3 +95,5 @@ To **list the existing user registration tokens**, use this command: ansible-playbook -i inventory/hosts setup.yml \ --tags=list-matrix-registration-tokens ``` + +The shortcut command with `just` program is also available: `just run-tags list-matrix-registration-tokens`. diff --git a/docs/configuring-playbook-mautrix-bridges.md b/docs/configuring-playbook-mautrix-bridges.md index e4619528f..25ba05cf2 100644 --- a/docs/configuring-playbook-mautrix-bridges.md +++ b/docs/configuring-playbook-mautrix-bridges.md @@ -100,6 +100,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Set up Double Puppeting To set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook. diff --git a/docs/configuring-playbook-ntfy.md b/docs/configuring-playbook-ntfy.md index a8315297f..048457d39 100644 --- a/docs/configuring-playbook-ntfy.md +++ b/docs/configuring-playbook-ntfy.md @@ -57,6 +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 install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-pantalaimon.md b/docs/configuring-playbook-pantalaimon.md index 0d1001c35..747daf60b 100644 --- a/docs/configuring-playbook-pantalaimon.md +++ b/docs/configuring-playbook-pantalaimon.md @@ -24,3 +24,7 @@ After configuring the playbook, run the [installation](installing.md) command: ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-postgres-backup.md b/docs/configuring-playbook-postgres-backup.md index a42c2a9d6..aa63a62e1 100644 --- a/docs/configuring-playbook-postgres-backup.md +++ b/docs/configuring-playbook-postgres-backup.md @@ -35,3 +35,7 @@ After configuring the playbook, run the [installation](installing.md) command: ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-prometheus-grafana.md b/docs/configuring-playbook-prometheus-grafana.md index 7b17e2ebc..d2e2f905b 100644 --- a/docs/configuring-playbook-prometheus-grafana.md +++ b/docs/configuring-playbook-prometheus-grafana.md @@ -62,6 +62,10 @@ 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 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) + ## What does it do? Name | Description diff --git a/docs/configuring-playbook-prometheus-nginxlog.md b/docs/configuring-playbook-prometheus-nginxlog.md index 858788683..edb24f892 100644 --- a/docs/configuring-playbook-prometheus-nginxlog.md +++ b/docs/configuring-playbook-prometheus-nginxlog.md @@ -29,6 +29,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just 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) + ## Docker Image Compatibility At the moment of writing only images for `amd64` and `arm64` architectures are available. The playbook currently does not support [self-building](./self-building.md) a container image on other architectures. You can however use a custom-build image by setting: diff --git a/docs/configuring-playbook-prometheus-postgres.md b/docs/configuring-playbook-prometheus-postgres.md index e7fffc5b3..ba89e6d72 100644 --- a/docs/configuring-playbook-prometheus-postgres.md +++ b/docs/configuring-playbook-prometheus-postgres.md @@ -19,6 +19,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just 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) + ## What does it do? Name | Description diff --git a/docs/configuring-playbook-rageshake.md b/docs/configuring-playbook-rageshake.md index c7aad4597..7f17d8d08 100644 --- a/docs/configuring-playbook-rageshake.md +++ b/docs/configuring-playbook-rageshake.md @@ -58,6 +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 install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-rest-auth.md b/docs/configuring-playbook-rest-auth.md index 054f99e2a..04911f3bd 100644 --- a/docs/configuring-playbook-rest-auth.md +++ b/docs/configuring-playbook-rest-auth.md @@ -32,3 +32,7 @@ After configuring the playbook, run the [installation](installing.md) command: ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-riot-web.md b/docs/configuring-playbook-riot-web.md index 9c97b6f04..4ca1f287c 100644 --- a/docs/configuring-playbook-riot-web.md +++ b/docs/configuring-playbook-riot-web.md @@ -36,3 +36,7 @@ After configuring the playbook, run the [installation](installing.md) command: ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-shared-secret-auth.md b/docs/configuring-playbook-shared-secret-auth.md index 97c9003f6..9b85c13b7 100644 --- a/docs/configuring-playbook-shared-secret-auth.md +++ b/docs/configuring-playbook-shared-secret-auth.md @@ -31,3 +31,7 @@ After configuring the playbook, run the [installation](installing.md) command: ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-sliding-sync-proxy.md b/docs/configuring-playbook-sliding-sync-proxy.md index 74efb8863..efcad8552 100644 --- a/docs/configuring-playbook-sliding-sync-proxy.md +++ b/docs/configuring-playbook-sliding-sync-proxy.md @@ -46,6 +46,10 @@ 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 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) + ### External databases Please note that, if your setup utilizes an external database, you must also establish configuration for the sliding sync proxy. Alter the defaults below to suit your configuration: diff --git a/docs/configuring-playbook-sygnal.md b/docs/configuring-playbook-sygnal.md index 681268aaa..ac137302d 100644 --- a/docs/configuring-playbook-sygnal.md +++ b/docs/configuring-playbook-sygnal.md @@ -84,6 +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 install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-synapse-auto-compressor.md b/docs/configuring-playbook-synapse-auto-compressor.md index 121a7fcf6..ea5d6f24e 100644 --- a/docs/configuring-playbook-synapse-auto-compressor.md +++ b/docs/configuring-playbook-synapse-auto-compressor.md @@ -25,6 +25,9 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) ## Usage diff --git a/docs/configuring-playbook-synapse-usage-exporter.md b/docs/configuring-playbook-synapse-usage-exporter.md index e22459df6..9edd3d2cf 100644 --- a/docs/configuring-playbook-synapse-usage-exporter.md +++ b/docs/configuring-playbook-synapse-usage-exporter.md @@ -56,3 +56,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ```sh ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` + +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) diff --git a/docs/configuring-playbook-user-verification-service.md b/docs/configuring-playbook-user-verification-service.md index 0664ae826..5bfce212c 100644 --- a/docs/configuring-playbook-user-verification-service.md +++ b/docs/configuring-playbook-user-verification-service.md @@ -96,6 +96,10 @@ After these variables have been set, run the [installation](installing.md) comma ansible-playbook -i inventory/hosts setup.yml --tags=setup-matrix-user-verification-service,start ``` +The shortcut commands with `just` program are also available: `just run-tags setup-matrix-user-verification-service,start` or `just run-tags setup-all,start`. + +`just run-tags setup-matrix-user-verification-service,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + ## Logging The configuration variable `UVS_LOG_LEVEL` can be set to: diff --git a/docs/faq.md b/docs/faq.md index 5afc5aca4..2b141b0cf 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -276,6 +276,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just 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) + **Note**: without setting up [server delegation](howto-server-delegation.md) to `matrix.example.com`, your user identifiers will be like `@user:matrix.example.com`. This is equivalent to having an email address like `bob@mail.company.com`, instead of just `bob@company.com`. ### I don't use the base domain for anything. How am I supposed to set up Server Delegation for Matrix services? diff --git a/docs/maintenance-and-troubleshooting.md b/docs/maintenance-and-troubleshooting.md index c8803c844..158d7abae 100644 --- a/docs/maintenance-and-troubleshooting.md +++ b/docs/maintenance-and-troubleshooting.md @@ -41,10 +41,13 @@ Re-run the playbook after making these configuration changes. ## Remove unused Docker data You can free some disk space from Docker, see [docker system prune](https://docs.docker.com/engine/reference/commandline/system_prune/) for more information. + ```sh ansible-playbook -i inventory/hosts setup.yml --tags=run-docker-prune ``` +The shortcut command with `just` program is also available: `just run-tags run-docker-prune`. + ## Postgres See the dedicated [PostgreSQL Maintenance](maintenance-postgres.md) documentation page. diff --git a/docs/maintenance-checking-services.md b/docs/maintenance-checking-services.md index e6975b9d1..672df9d9c 100644 --- a/docs/maintenance-checking-services.md +++ b/docs/maintenance-checking-services.md @@ -8,6 +8,8 @@ To perform the check, run: ansible-playbook -i inventory/hosts setup.yml --tags=self-check ``` +The shortcut command with `just` program is also available: `just run-tags self-check`. + If it's all green, everything is probably running correctly. Besides this self-check, you can also check whether your server federates with the Matrix network by using the [Federation Tester](https://federationtester.matrix.org/) against your base domain (`example.com`), not the `matrix.example.com` subdomain. diff --git a/docs/maintenance-migrating.md b/docs/maintenance-migrating.md index 29a2beb52..f9c37eb6d 100644 --- a/docs/maintenance-migrating.md +++ b/docs/maintenance-migrating.md @@ -46,6 +46,8 @@ Then, run the command below on your local computer to create the `matrix` user a ansible-playbook -i inventory/hosts setup.yml --tags=setup-system-user ``` +The shortcut command with `just` program is also available: `just run-tags setup-system-user`. + **Note**: because the `matrix` user and group are created dynamically on each server, the user/group ID may differ between the old and new server. We suggest that you adjust ownership of `/matrix` files. To adjust the ownership, log in to the new server and run the command: ```sh @@ -60,6 +62,8 @@ Finally, run the command below on your local computer to finish the installation ansible-playbook -i inventory/hosts setup.yml --tags=install-all,start ``` +The shortcut command with `just` program is also available: `just run-tags install-all,start`. + ### Check if services work After starting the services, you probably might want to ensure that you've migrated things correctly and that services are running. For instructions, see: [check if services work](maintenance-checking-services.md) diff --git a/docs/maintenance-synapse.md b/docs/maintenance-synapse.md index fdf2856d7..3ccc04c16 100644 --- a/docs/maintenance-synapse.md +++ b/docs/maintenance-synapse.md @@ -39,6 +39,8 @@ To ask the playbook to run rust-synapse-compress-state, execute: ansible-playbook -i inventory/hosts setup.yml --tags=rust-synapse-compress-state ``` +The shortcut command with `just` program is also available: `just run-tags rust-synapse-compress-state`. + By default, all rooms with more than `100000` state group rows will be compressed. If you need to adjust this, pass: `--extra-vars='matrix_synapse_rust_synapse_compress_state_min_state_groups_required=SOME_NUMBER_HERE'` to the command above. After state compression, you may wish to run a [`FULL` Postgres `VACUUM`](./maintenance-postgres.md#vacuuming-postgresql). diff --git a/docs/registering-users.md b/docs/registering-users.md index 89091880b..2aa21e3d8 100644 --- a/docs/registering-users.md +++ b/docs/registering-users.md @@ -119,6 +119,10 @@ After configuring the playbook, run the [installation](installing.md) command: ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ``` +The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`. + +`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md) + If you're opening up registrations publicly like this, you might also wish to [configure CAPTCHA protection](configuring-captcha.md).