It also explains difference between "just install-all" and "just setup-all" recipes. The explanation is based on docs/playbook-tags.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3842/head
| @@ -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 | 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). | Then, you can proceed to [Usage](#usage). | ||||
| @@ -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 | 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 | ## Usage | ||||
| When enabled, double puppeting will automatically be enabled for all bridges that support double puppeting via the appservice method. | When enabled, double puppeting will automatically be enabled for all bridges that support double puppeting via the appservice method. | ||||
| @@ -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 | 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 | ## Usage | ||||
| @@ -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 | 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 | ## 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. | 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. | ||||
| @@ -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 | 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**: | **Notes**: | ||||
| - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account | - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account | ||||
| @@ -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 | 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**: | **Notes**: | ||||
| - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account | - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account | ||||
| @@ -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 | 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 | ## Usage | ||||
| @@ -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 | 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 | ## Usage | ||||
| @@ -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 | 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 | ## Usage | ||||
| @@ -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 | 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**: | **Notes**: | ||||
| - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account | - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account | ||||
| @@ -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 | 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 | ## 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). | 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). | ||||
| @@ -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 | 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**: | **Notes**: | ||||
| - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account | - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account | ||||
| @@ -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 | 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**: | **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 | - 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 | ||||
| @@ -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 | 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 | ## Usage | ||||
| @@ -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 | 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 (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: | 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: | ||||
| @@ -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 | 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 | ## Usage | ||||
| You then need to start a chat with `@irc_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | You then need to start a chat with `@irc_bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## Usage | ||||
| Start a chat with `@kakaotalkbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | Start a chat with `@kakaotalkbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## Usage | ||||
| Send `/invite @slackbot:example.com` to invite the bridge bot user into the admin room. | Send `/invite @slackbot:example.com` to invite the bridge bot user into the admin room. | ||||
| @@ -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 | 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 | ## Usage | ||||
| Invite the bridge bot user to your room in either way. | Invite the bridge bot user to your room in either way. | ||||
| @@ -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 | 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 | ## 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. | 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. | ||||
| @@ -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 | 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 | ## 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). | 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). | ||||
| @@ -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 | 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 | ## 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. | 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. | ||||
| @@ -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 | 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 | ## Usage | ||||
| Read the [user guide](https://github.com/benkuly/matrix-sms-bridge/blob/master/README.md#user-guide) to see how this bridge works. | Read the [user guide](https://github.com/benkuly/matrix-sms-bridge/blob/master/README.md#user-guide) to see how this bridge works. | ||||
| @@ -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 | 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 | ## Usage | ||||
| ### Logging in | ### Logging in | ||||
| @@ -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 | 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 | ## Usage | ||||
| You then need to start a chat with `@facebookbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | You then need to start a chat with `@facebookbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## Usage | ||||
| You then need to start a chat with `@gmessagesbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | You then need to start a chat with `@gmessagesbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## 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). | 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). | ||||
| @@ -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 | 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 | ## 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). | 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). | ||||
| @@ -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 | 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 | ## Usage | ||||
| You then need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | You then need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## Usage | ||||
| You then need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | You then need to start a chat with `@instagrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## 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`. | 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`. | ||||
| @@ -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 | 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 | ## Usage | ||||
| You then need to start a chat with `@signalbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | You then need to start a chat with `@signalbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## Usage | ||||
| 1. Start a chat with `@slackbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | 1. Start a chat with `@slackbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## Usage | ||||
| You then need to start a chat with `@telegrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | You then need to start a chat with `@telegrambot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## Usage | ||||
| 1. You then need to start a chat with `@twitterbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | 1. You then need to start a chat with `@twitterbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## Usage | ||||
| You then need to start a chat with `@whatsappbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | You then need to start a chat with `@whatsappbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## 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). | 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). | ||||
| @@ -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 | 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 | ## 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). | 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). | ||||
| @@ -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 | 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 | ## 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). | 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). | ||||
| @@ -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 | 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 | ## 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). | 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). | ||||
| @@ -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 | 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 | ## 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). | 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). | ||||
| @@ -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 | 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 | ## 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). | 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). | ||||
| @@ -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 | 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 | ## 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). | 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). | ||||
| @@ -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 | 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**: | **Notes**: | ||||
| - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create a user account of the bridge's bot | - the `ensure-matrix-users-created` playbook tag makes the playbook automatically create a user account of the bridge's bot | ||||
| @@ -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 | 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 | ## Usage | ||||
| Once the bridge is installed, start a chat with `@wechatbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | Once the bridge is installed, start a chat with `@wechatbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain). | ||||
| @@ -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 | 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 | ## Usage | ||||
| Upon starting Cactus Comments, a `bot.cactusbot` user account is created automatically. | Upon starting Cactus Comments, a `bot.cactusbot` user account is created automatically. | ||||
| @@ -48,3 +48,7 @@ After configuring the playbook and [adjusting your DNS records](#adjusting-dns-r | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -77,3 +77,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -45,3 +45,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -75,3 +75,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -40,3 +40,7 @@ After configuring the playbook, run the [installation](installing.md) command: | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -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 | 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. | 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. | ||||
| @@ -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 | 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 Reading | ||||
| Additional resources: | Additional resources: | ||||
| @@ -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 | 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 | ## 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`. | 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`. | ||||
| @@ -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 | 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 | ## Usage | ||||
| You can use the self-hosted Jitsi server in multiple ways: | You can use the self-hosted Jitsi server in multiple ways: | ||||
| @@ -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 | 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 | ## 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). | If email address validation emails sent by ma1sd are not reaching you, you should look into [Adjusting email-sending settings](configuring-playbook-email.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 | 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. | 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). | 💡 After installation, you should [verify that Matrix Authentication Service is installed correctly](#verify-that-matrix-authentication-service-is-installed-correctly). | ||||
| @@ -40,3 +40,7 @@ After configuring the playbook, run the [installation](installing.md) command: | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -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 | 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 | ## Usage | ||||
| @@ -92,3 +95,5 @@ To **list the existing user registration tokens**, use this command: | |||||
| ansible-playbook -i inventory/hosts setup.yml \ | ansible-playbook -i inventory/hosts setup.yml \ | ||||
| --tags=list-matrix-registration-tokens | --tags=list-matrix-registration-tokens | ||||
| ``` | ``` | ||||
| The shortcut command with `just` program is also available: `just run-tags list-matrix-registration-tokens`. | |||||
| @@ -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 | 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 | ## 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. | 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. | ||||
| @@ -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 | 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 | ## Usage | ||||
| @@ -24,3 +24,7 @@ After configuring the playbook, run the [installation](installing.md) command: | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -35,3 +35,7 @@ After configuring the playbook, run the [installation](installing.md) command: | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -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 | 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? | ## What does it do? | ||||
| Name | Description | Name | Description | ||||
| @@ -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 | 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 | ## 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: | 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: | ||||
| @@ -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 | 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? | ## What does it do? | ||||
| Name | Description | Name | Description | ||||
| @@ -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 | 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 | ## Usage | ||||
| @@ -32,3 +32,7 @@ After configuring the playbook, run the [installation](installing.md) command: | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -36,3 +36,7 @@ After configuring the playbook, run the [installation](installing.md) command: | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -31,3 +31,7 @@ After configuring the playbook, run the [installation](installing.md) command: | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -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 | 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 | ### 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: | 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: | ||||
| @@ -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 | 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 | ## Usage | ||||
| @@ -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 | 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 | ## Usage | ||||
| @@ -56,3 +56,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj | |||||
| ```sh | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start | 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) | |||||
| @@ -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 | 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 | ## Logging | ||||
| The configuration variable `UVS_LOG_LEVEL` can be set to: | The configuration variable `UVS_LOG_LEVEL` can be set to: | ||||
| @@ -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 | 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`. | **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? | ### I don't use the base domain for anything. How am I supposed to set up Server Delegation for Matrix services? | ||||
| @@ -41,10 +41,13 @@ Re-run the playbook after making these configuration changes. | |||||
| ## Remove unused Docker data | ## 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. | 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 | ```sh | ||||
| ansible-playbook -i inventory/hosts setup.yml --tags=run-docker-prune | 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 | ## Postgres | ||||
| See the dedicated [PostgreSQL Maintenance](maintenance-postgres.md) documentation page. | See the dedicated [PostgreSQL Maintenance](maintenance-postgres.md) documentation page. | ||||
| @@ -8,6 +8,8 @@ To perform the check, run: | |||||
| ansible-playbook -i inventory/hosts setup.yml --tags=self-check | 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. | 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. | 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. | ||||
| @@ -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 | 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: | **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 | ```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 | 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 | ### 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) | 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) | ||||
| @@ -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 | 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. | 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). | After state compression, you may wish to run a [`FULL` Postgres `VACUUM`](./maintenance-postgres.md#vacuuming-postgresql). | ||||
| @@ -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 | 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). | If you're opening up registrations publicly like this, you might also wish to [configure CAPTCHA protection](configuring-captcha.md). | ||||