Просмотр исходного кода

Add description about shortcut command with the "just" program to the ansible-playbook command with "setup-all" and "start" tags

It also explains difference between "just install-all" and "just setup-all" recipes. The explanation is based on docs/playbook-tags.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3842/head
Suguru Hirahara 1 год назад
Родитель
Сommit
6777f54ebc
Не найден GPG ключ соответствующий данной подписи Идентификатор GPG ключа: E4F9743DAB4B7B75
81 измененных файлов: 311 добавлений и 0 удалений
  1. +4
    -0
      docs/configuring-playbook-alertmanager-receiver.md
  2. +4
    -0
      docs/configuring-playbook-appservice-double-puppet.md
  3. +3
    -0
      docs/configuring-playbook-appservice-draupnir-for-all.md
  4. +4
    -0
      docs/configuring-playbook-backup-borg.md
  5. +4
    -0
      docs/configuring-playbook-bot-baibot.md
  6. +4
    -0
      docs/configuring-playbook-bot-buscarron.md
  7. +3
    -0
      docs/configuring-playbook-bot-chatgpt.md
  8. +3
    -0
      docs/configuring-playbook-bot-draupnir.md
  9. +3
    -0
      docs/configuring-playbook-bot-go-neb.md
  10. +4
    -0
      docs/configuring-playbook-bot-honoroit.md
  11. +4
    -0
      docs/configuring-playbook-bot-matrix-registration-bot.md
  12. +4
    -0
      docs/configuring-playbook-bot-matrix-reminder-bot.md
  13. +4
    -0
      docs/configuring-playbook-bot-maubot.md
  14. +3
    -0
      docs/configuring-playbook-bot-mjolnir.md
  15. +4
    -0
      docs/configuring-playbook-bridge-appservice-discord.md
  16. +4
    -0
      docs/configuring-playbook-bridge-appservice-irc.md
  17. +4
    -0
      docs/configuring-playbook-bridge-appservice-kakaotalk.md
  18. +4
    -0
      docs/configuring-playbook-bridge-appservice-slack.md
  19. +4
    -0
      docs/configuring-playbook-bridge-appservice-webhooks.md
  20. +4
    -0
      docs/configuring-playbook-bridge-beeper-linkedin.md
  21. +4
    -0
      docs/configuring-playbook-bridge-go-skype-bridge.md
  22. +4
    -0
      docs/configuring-playbook-bridge-heisenbridge.md
  23. +4
    -0
      docs/configuring-playbook-bridge-matrix-bridge-sms.md
  24. +4
    -0
      docs/configuring-playbook-bridge-mautrix-discord.md
  25. +4
    -0
      docs/configuring-playbook-bridge-mautrix-facebook.md
  26. +4
    -0
      docs/configuring-playbook-bridge-mautrix-gmessages.md
  27. +4
    -0
      docs/configuring-playbook-bridge-mautrix-googlechat.md
  28. +4
    -0
      docs/configuring-playbook-bridge-mautrix-hangouts.md
  29. +4
    -0
      docs/configuring-playbook-bridge-mautrix-instagram.md
  30. +4
    -0
      docs/configuring-playbook-bridge-mautrix-meta-instagram.md
  31. +4
    -0
      docs/configuring-playbook-bridge-mautrix-meta-messenger.md
  32. +4
    -0
      docs/configuring-playbook-bridge-mautrix-signal.md
  33. +4
    -0
      docs/configuring-playbook-bridge-mautrix-slack.md
  34. +4
    -0
      docs/configuring-playbook-bridge-mautrix-telegram.md
  35. +4
    -0
      docs/configuring-playbook-bridge-mautrix-twitter.md
  36. +4
    -0
      docs/configuring-playbook-bridge-mautrix-whatsapp.md
  37. +4
    -0
      docs/configuring-playbook-bridge-mautrix-wsproxy.md
  38. +4
    -0
      docs/configuring-playbook-bridge-mx-puppet-discord.md
  39. +4
    -0
      docs/configuring-playbook-bridge-mx-puppet-groupme.md
  40. +4
    -0
      docs/configuring-playbook-bridge-mx-puppet-instagram.md
  41. +4
    -0
      docs/configuring-playbook-bridge-mx-puppet-slack.md
  42. +4
    -0
      docs/configuring-playbook-bridge-mx-puppet-steam.md
  43. +4
    -0
      docs/configuring-playbook-bridge-mx-puppet-twitter.md
  44. +4
    -0
      docs/configuring-playbook-bridge-postmoogle.md
  45. +4
    -0
      docs/configuring-playbook-bridge-wechat.md
  46. +4
    -0
      docs/configuring-playbook-cactus-comments.md
  47. +4
    -0
      docs/configuring-playbook-client-cinny.md
  48. +4
    -0
      docs/configuring-playbook-client-element-web.md
  49. +4
    -0
      docs/configuring-playbook-client-hydrogen.md
  50. +4
    -0
      docs/configuring-playbook-client-schildichat-web.md
  51. +4
    -0
      docs/configuring-playbook-dendrite.md
  52. +4
    -0
      docs/configuring-playbook-dimension.md
  53. +4
    -0
      docs/configuring-playbook-dynamic-dns.md
  54. +4
    -0
      docs/configuring-playbook-etherpad.md
  55. +4
    -0
      docs/configuring-playbook-jitsi.md
  56. +4
    -0
      docs/configuring-playbook-ma1sd.md
  57. +4
    -0
      docs/configuring-playbook-matrix-authentication-service.md
  58. +4
    -0
      docs/configuring-playbook-matrix-ldap-registration-proxy.md
  59. +5
    -0
      docs/configuring-playbook-matrix-registration.md
  60. +4
    -0
      docs/configuring-playbook-mautrix-bridges.md
  61. +3
    -0
      docs/configuring-playbook-ntfy.md
  62. +4
    -0
      docs/configuring-playbook-pantalaimon.md
  63. +4
    -0
      docs/configuring-playbook-postgres-backup.md
  64. +4
    -0
      docs/configuring-playbook-prometheus-grafana.md
  65. +4
    -0
      docs/configuring-playbook-prometheus-nginxlog.md
  66. +4
    -0
      docs/configuring-playbook-prometheus-postgres.md
  67. +3
    -0
      docs/configuring-playbook-rageshake.md
  68. +4
    -0
      docs/configuring-playbook-rest-auth.md
  69. +4
    -0
      docs/configuring-playbook-riot-web.md
  70. +4
    -0
      docs/configuring-playbook-shared-secret-auth.md
  71. +4
    -0
      docs/configuring-playbook-sliding-sync-proxy.md
  72. +3
    -0
      docs/configuring-playbook-sygnal.md
  73. +3
    -0
      docs/configuring-playbook-synapse-auto-compressor.md
  74. +4
    -0
      docs/configuring-playbook-synapse-usage-exporter.md
  75. +4
    -0
      docs/configuring-playbook-user-verification-service.md
  76. +4
    -0
      docs/faq.md
  77. +3
    -0
      docs/maintenance-and-troubleshooting.md
  78. +2
    -0
      docs/maintenance-checking-services.md
  79. +4
    -0
      docs/maintenance-migrating.md
  80. +2
    -0
      docs/maintenance-synapse.md
  81. +4
    -0
      docs/registering-users.md

+ 4
- 0
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).




+ 4
- 0
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.

+ 3
- 0
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



+ 4
- 0
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.

+ 4
- 0
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


+ 4
- 0
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


+ 3
- 0
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



+ 3
- 0
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



+ 3
- 0
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



+ 4
- 0
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


+ 4
- 0
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).


+ 4
- 0
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


+ 4
- 0
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


+ 3
- 0
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



+ 4
- 0
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:


+ 4
- 0
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).

+ 4
- 0
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).


+ 4
- 0
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.


+ 4
- 0
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.


+ 4
- 0
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.


+ 4
- 0
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).


+ 4
- 0
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.


+ 4
- 0
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.

+ 4
- 0
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


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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`.


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).

+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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


+ 4
- 0
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).


+ 4
- 0
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.


+ 4
- 0
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)

+ 4
- 0
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)

+ 4
- 0
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)

+ 4
- 0
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)

+ 4
- 0
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)

+ 4
- 0
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.




+ 4
- 0
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:


+ 4
- 0
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`.


+ 4
- 0
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:


+ 4
- 0
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).


+ 4
- 0
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).


+ 4
- 0
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)

+ 5
- 0
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`.

+ 4
- 0
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.


+ 3
- 0
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



+ 4
- 0
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)

+ 4
- 0
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)

+ 4
- 0
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


+ 4
- 0
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:


+ 4
- 0
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


+ 3
- 0
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



+ 4
- 0
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)

+ 4
- 0
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)

+ 4
- 0
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)

+ 4
- 0
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:


+ 3
- 0
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



+ 3
- 0
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



+ 4
- 0
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)

+ 4
- 0
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:


+ 4
- 0
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?


+ 3
- 0
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.


+ 2
- 0
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.

+ 4
- 0
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)


+ 2
- 0
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).


+ 4
- 0
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).




Загрузка…
Отмена
Сохранить