Kaynağa Gözat

Edit descriptions about installation of components (#3842)

* Replace installation command shortcut for the "just" program with the most conservative raw ansible-playbook command

This commit replaces installation command shortcut ("recipe") for the "just" program with the raw ansible-playbook command, so that the shortcut will be added to it later. The command is so conservative that failure of the command will mean something is clearly broken.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Add comments about using setup-all instead of install-all

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* 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>

* Update raw ansible-playbook command to have it do what "just install-all" or "just setup-all" does

Since "just install-all" or "just setup-all" invokes "ensure-matrix-users-created" as well, it needs adding to the raw ansible-playbook command.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Remove "ensure-matrix-users-created" from the raw ansible-playbook command which does not need it

Also: update the "just" recipes accordingly. "just install-all" and "just setup-all" run "ensure-matrix-users-created" tag as well, therefore they need to be replaced with "run-tags" recipes to skip "ensure-matrix-users-created"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-etherpad.md: add ensure-matrix-users-created to the raw ansible-playbook

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Add description about "ensure-matrix-users-created" and create a list with description about shortcut commands with "just"

This commit also fixes list item capitalization and punctuation.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Add notes bullet lists

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-matrix-corporal.md and docs/configuring-playbook-email2matrix.md: adopt common instructions

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Replace "run the installation command" with "run the playbook with tags"

Now that shortcut commands for the "just" program are displayed along with the existing "installation command", this commit replaces "run the installation command" with "run the playbook with tags" in order to prevent misunderstanding and confusion.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Add notes about changing passwords of users specified on vars.yml

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-synapse-admin.md: add the playbook command and just recipes

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Remove redundant blank lines

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-alertmanager-receiver.md: remove the direction to proceed to Usage

Such a kind of direction is not used on other documentation, so it should be fine to just remove it.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/importing-synapse-media-store.md: code block for ansible-playbook

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
pull/3843/head
Suguru Hirahara 1 yıl önce
committed by GitHub
ebeveyn
işleme
20c2aade3e
Veri tabanında bu imza için bilinen anahtar bulunamadı GPG Anahtar Kimliği: B5690EEEBB952194
85 değiştirilmiş dosya ile 895 ekleme ve 111 silme
  1. +12
    -2
      docs/configuring-playbook-alertmanager-receiver.md
  2. +14
    -1
      docs/configuring-playbook-appservice-double-puppet.md
  3. +10
    -2
      docs/configuring-playbook-appservice-draupnir-for-all.md
  4. +6
    -1
      docs/configuring-playbook-backup-borg.md
  5. +8
    -4
      docs/configuring-playbook-bot-baibot.md
  6. +7
    -3
      docs/configuring-playbook-bot-buscarron.md
  7. +10
    -2
      docs/configuring-playbook-bot-chatgpt.md
  8. +12
    -2
      docs/configuring-playbook-bot-draupnir.md
  9. +10
    -2
      docs/configuring-playbook-bot-go-neb.md
  10. +7
    -3
      docs/configuring-playbook-bot-honoroit.md
  11. +16
    -1
      docs/configuring-playbook-bot-matrix-registration-bot.md
  12. +7
    -3
      docs/configuring-playbook-bot-matrix-reminder-bot.md
  13. +13
    -2
      docs/configuring-playbook-bot-maubot.md
  14. +12
    -2
      docs/configuring-playbook-bot-mjolnir.md
  15. +11
    -2
      docs/configuring-playbook-bridge-appservice-discord.md
  16. +14
    -1
      docs/configuring-playbook-bridge-appservice-irc.md
  17. +11
    -2
      docs/configuring-playbook-bridge-appservice-kakaotalk.md
  18. +11
    -2
      docs/configuring-playbook-bridge-appservice-slack.md
  19. +11
    -2
      docs/configuring-playbook-bridge-appservice-webhooks.md
  20. +14
    -1
      docs/configuring-playbook-bridge-beeper-linkedin.md
  21. +14
    -1
      docs/configuring-playbook-bridge-go-skype-bridge.md
  22. +14
    -1
      docs/configuring-playbook-bridge-heisenbridge.md
  23. +14
    -1
      docs/configuring-playbook-bridge-matrix-bridge-sms.md
  24. +11
    -2
      docs/configuring-playbook-bridge-mautrix-discord.md
  25. +14
    -1
      docs/configuring-playbook-bridge-mautrix-facebook.md
  26. +14
    -1
      docs/configuring-playbook-bridge-mautrix-gmessages.md
  27. +14
    -1
      docs/configuring-playbook-bridge-mautrix-googlechat.md
  28. +14
    -1
      docs/configuring-playbook-bridge-mautrix-hangouts.md
  29. +14
    -1
      docs/configuring-playbook-bridge-mautrix-instagram.md
  30. +14
    -1
      docs/configuring-playbook-bridge-mautrix-meta-instagram.md
  31. +14
    -1
      docs/configuring-playbook-bridge-mautrix-meta-messenger.md
  32. +14
    -1
      docs/configuring-playbook-bridge-mautrix-signal.md
  33. +11
    -2
      docs/configuring-playbook-bridge-mautrix-slack.md
  34. +14
    -1
      docs/configuring-playbook-bridge-mautrix-telegram.md
  35. +14
    -1
      docs/configuring-playbook-bridge-mautrix-twitter.md
  36. +14
    -1
      docs/configuring-playbook-bridge-mautrix-whatsapp.md
  37. +14
    -1
      docs/configuring-playbook-bridge-mautrix-wsproxy.md
  38. +14
    -1
      docs/configuring-playbook-bridge-mx-puppet-discord.md
  39. +14
    -1
      docs/configuring-playbook-bridge-mx-puppet-groupme.md
  40. +14
    -1
      docs/configuring-playbook-bridge-mx-puppet-instagram.md
  41. +11
    -2
      docs/configuring-playbook-bridge-mx-puppet-slack.md
  42. +14
    -1
      docs/configuring-playbook-bridge-mx-puppet-steam.md
  43. +14
    -1
      docs/configuring-playbook-bridge-mx-puppet-twitter.md
  44. +7
    -3
      docs/configuring-playbook-bridge-postmoogle.md
  45. +14
    -1
      docs/configuring-playbook-bridge-wechat.md
  46. +14
    -1
      docs/configuring-playbook-cactus-comments.md
  47. +10
    -1
      docs/configuring-playbook-client-cinny.md
  48. +10
    -1
      docs/configuring-playbook-client-element-web.md
  49. +10
    -1
      docs/configuring-playbook-client-hydrogen.md
  50. +10
    -1
      docs/configuring-playbook-client-schildichat-web.md
  51. +10
    -1
      docs/configuring-playbook-dendrite.md
  52. +8
    -2
      docs/configuring-playbook-dimension.md
  53. +10
    -1
      docs/configuring-playbook-dynamic-dns.md
  54. +12
    -2
      docs/configuring-playbook-email2matrix.md
  55. +16
    -1
      docs/configuring-playbook-etherpad.md
  56. +6
    -1
      docs/configuring-playbook-jitsi.md
  57. +10
    -1
      docs/configuring-playbook-ma1sd.md
  58. +13
    -2
      docs/configuring-playbook-matrix-authentication-service.md
  59. +9
    -1
      docs/configuring-playbook-matrix-corporal.md
  60. +10
    -1
      docs/configuring-playbook-matrix-ldap-registration-proxy.md
  61. +7
    -1
      docs/configuring-playbook-matrix-registration.md
  62. +14
    -1
      docs/configuring-playbook-mautrix-bridges.md
  63. +5
    -1
      docs/configuring-playbook-ntfy.md
  64. +10
    -1
      docs/configuring-playbook-pantalaimon.md
  65. +6
    -1
      docs/configuring-playbook-postgres-backup.md
  66. +10
    -1
      docs/configuring-playbook-prometheus-grafana.md
  67. +10
    -1
      docs/configuring-playbook-prometheus-nginxlog.md
  68. +10
    -1
      docs/configuring-playbook-prometheus-postgres.md
  69. +5
    -1
      docs/configuring-playbook-rageshake.md
  70. +10
    -1
      docs/configuring-playbook-rest-auth.md
  71. +10
    -1
      docs/configuring-playbook-riot-web.md
  72. +10
    -1
      docs/configuring-playbook-shared-secret-auth.md
  73. +10
    -1
      docs/configuring-playbook-sliding-sync-proxy.md
  74. +5
    -1
      docs/configuring-playbook-sygnal.md
  75. +10
    -1
      docs/configuring-playbook-synapse-admin.md
  76. +5
    -1
      docs/configuring-playbook-synapse-auto-compressor.md
  77. +10
    -1
      docs/configuring-playbook-synapse-usage-exporter.md
  78. +5
    -1
      docs/configuring-playbook-user-verification-service.md
  79. +9
    -2
      docs/faq.md
  80. +3
    -1
      docs/importing-synapse-media-store.md
  81. +3
    -0
      docs/maintenance-and-troubleshooting.md
  82. +2
    -0
      docs/maintenance-checking-services.md
  83. +4
    -0
      docs/maintenance-migrating.md
  84. +2
    -0
      docs/maintenance-synapse.md
  85. +12
    -2
      docs/registering-users.md

+ 12
- 2
docs/configuring-playbook-alertmanager-receiver.md Dosyayı Görüntüle

@@ -76,10 +76,20 @@ Steps 3 and 4 need to be done for each new room you'd like the bot to deliver al


## Installing ## Installing


Now that you've [prepared the bot account and room](#account-and-room-preparation), [configured the playbook](#adjusting-the-playbook-configuration), and potentially [adjusted your DNS records](#adjusting-dns-records), you can run the [installation](installing.md) command: `just install-all`
Now that you've [prepared the bot account and room](#account-and-room-preparation), [configured the playbook](#adjusting-the-playbook-configuration), and potentially [adjusted your DNS records](#adjusting-dns-records), you can run the playbook with [playbook tags](playbook-tags.md) as below:


Then, you can proceed to [Usage](#usage).
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`


`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-appservice-double-puppet.md Dosyayı Görüntüle

@@ -16,7 +16,20 @@ matrix_appservice_double_puppet_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 10
- 2
docs/configuring-playbook-appservice-draupnir-for-all.md Dosyayı Görüntüle

@@ -49,12 +49,20 @@ matrix_appservice_draupnir_for_all_master_control_room_alias: "ALIAS_FROM_STEP_2


### 4. Installing ### 4. Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 6
- 1
docs/configuring-playbook-backup-borg.md Dosyayı Görüntüle

@@ -71,12 +71,17 @@ Check the [backup_borg role](https://github.com/mother-of-all-self-hosting/ansib


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```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 run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

## 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.

+ 8
- 4
docs/configuring-playbook-bot-baibot.md Dosyayı Görüntüle

@@ -376,18 +376,22 @@ matrix_bot_baibot_config_initial_global_config_handler_image_generation: null


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
just run-tags install-all,ensure-matrix-users-created,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**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.


- if you change the bot password (`matrix_bot_baibot_config_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_baibot_config_user_password` to let the bot know its new password
- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`


`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- If you change the bot password (`matrix_bot_baibot_config_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_baibot_config_user_password` to let the bot know its new password.


## Usage ## Usage




+ 7
- 3
docs/configuring-playbook-bot-buscarron.md Dosyayı Görüntüle

@@ -56,18 +56,22 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
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
``` ```


**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.


- if you change the bot password (`matrix_bot_buscarron_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_buscarron_password` to let the bot know its new password
- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`


`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- If you change the bot password (`matrix_bot_buscarron_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_buscarron_password` to let the bot know its new password.


## Usage ## Usage




+ 10
- 2
docs/configuring-playbook-bot-chatgpt.md Dosyayı Görüntüle

@@ -56,12 +56,20 @@ You will need to get tokens for ChatGPT.


## 4. Installing ## 4. Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=install-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 12
- 2
docs/configuring-playbook-bot-draupnir.md Dosyayı Görüntüle

@@ -115,12 +115,22 @@ That is all you need to do due to that Draupnir can complete migration on its ow


## 6. Installing ## 6. Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- If you change the Pantalaimon's password (`matrix_bot_draupnir_pantalaimon_password` in your `vars.yml` file) subsequently, its credentials on the homeserver won't be updated automatically. If you'd like to change the password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_draupnir_pantalaimon_password` to let Pantalaimon know its new password.


## Usage ## Usage




+ 10
- 2
docs/configuring-playbook-bot-go-neb.md Dosyayı Görüntüle

@@ -219,12 +219,20 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 7
- 3
docs/configuring-playbook-bot-honoroit.md Dosyayı Görüntüle

@@ -48,18 +48,22 @@ If you've decided to use the default hostname, you won't need to do any extra DN


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
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
``` ```


**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.


- if you change the bot password (`matrix_bot_honoroit_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_honoroit_password` to let the bot know its new password
- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`


`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- If you change the bot password (`matrix_bot_honoroit_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_honoroit_password` to let the bot know its new password.


## Usage ## Usage




+ 16
- 1
docs/configuring-playbook-bot-matrix-registration-bot.md Dosyayı Görüntüle

@@ -32,7 +32,22 @@ The bot account will be created automatically.


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- If you change the bot password (`matrix_bot_matrix_registration_bot_bot_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_registration_bot_bot_password` to let the bot know its new password.


## Usage ## Usage




+ 7
- 3
docs/configuring-playbook-bot-matrix-reminder-bot.md Dosyayı Görüntüle

@@ -27,18 +27,22 @@ matrix_bot_matrix_reminder_bot_reminders_timezone: Europe/London


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
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
``` ```


**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.


- if you change the bot password (`matrix_bot_matrix_reminder_bot_matrix_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_reminder_bot_matrix_user_password` to let the bot know its new password
- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`


`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- If you change the bot password (`matrix_bot_matrix_reminder_bot_matrix_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_matrix_reminder_bot_matrix_user_password` to let the bot know its new password.


## Usage ## Usage




+ 13
- 2
docs/configuring-playbook-bot-maubot.md Dosyayı Görüntüle

@@ -49,11 +49,22 @@ If you've decided to use the default hostname, you won't need to do any extra DN


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all`
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```


**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
- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- If you change the bot password (`matrix_bot_maubot_initial_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_maubot_initial_password` to let the bot know its new password.


## Usage ## Usage




+ 12
- 2
docs/configuring-playbook-bot-mjolnir.md Dosyayı Görüntüle

@@ -117,12 +117,22 @@ matrix_synapse_ext_spam_checker_mjolnir_antispam_config_ban_lists: []


## 7. Installing ## 7. Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- If you change the Pantalaimon's password (`matrix_bot_mjolnir_pantalaimon_password` in your `vars.yml` file) subsequently, its credentials on the homeserver won't be updated automatically. If you'd like to change the password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_mjolnir_pantalaimon_password` to let Pantalaimon know its new password.


## Usage ## Usage




+ 11
- 2
docs/configuring-playbook-bridge-appservice-discord.md Dosyayı Görüntüle

@@ -30,12 +30,21 @@ matrix_appservice_discord_bot_token: "YOUR DISCORD APP BOT TOKEN"


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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:


+ 14
- 1
docs/configuring-playbook-bridge-appservice-irc.md Dosyayı Görüntüle

@@ -62,7 +62,20 @@ matrix_appservice_irc_ircService_servers:


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 11
- 2
docs/configuring-playbook-bridge-appservice-kakaotalk.md Dosyayı Görüntüle

@@ -33,12 +33,21 @@ Take a look at:


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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).


+ 11
- 2
docs/configuring-playbook-bridge-appservice-slack.md Dosyayı Görüntüle

@@ -65,12 +65,21 @@ Other configuration options are available via the `matrix_appservice_slack_confi


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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.


+ 11
- 2
docs/configuring-playbook-bridge-appservice-webhooks.md Dosyayı Görüntüle

@@ -26,12 +26,21 @@ matrix_appservice_webhooks_api_secret: '<your_secret>'


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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.


+ 14
- 1
docs/configuring-playbook-bridge-beeper-linkedin.md Dosyayı Görüntüle

@@ -35,7 +35,20 @@ You may wish to look at `roles/custom/matrix-bridge-beeper-linkedin/templates/co


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-go-skype-bridge.md Dosyayı Görüntüle

@@ -14,7 +14,20 @@ matrix_go_skype_bridge_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-heisenbridge.md Dosyayı Görüntüle

@@ -49,7 +49,20 @@ If you've decided to use the default hostname, you won't need to do any extra DN


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-matrix-bridge-sms.md Dosyayı Görüntüle

@@ -33,7 +33,20 @@ matrix_sms_bridge_provider_android_truststore_password: 123


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 11
- 2
docs/configuring-playbook-bridge-mautrix-discord.md Dosyayı Görüntüle

@@ -42,12 +42,21 @@ Take a look at:


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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


+ 14
- 1
docs/configuring-playbook-bridge-mautrix-facebook.md Dosyayı Görüntüle

@@ -55,7 +55,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-facebook/templates/c


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mautrix-gmessages.md Dosyayı Görüntüle

@@ -20,7 +20,20 @@ matrix_mautrix_gmessages_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mautrix-googlechat.md Dosyayı Görüntüle

@@ -20,7 +20,20 @@ matrix_mautrix_googlechat_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mautrix-hangouts.md Dosyayı Görüntüle

@@ -22,7 +22,20 @@ matrix_mautrix_hangouts_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mautrix-instagram.md Dosyayı Görüntüle

@@ -42,7 +42,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-instagram/templates/


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mautrix-meta-instagram.md Dosyayı Görüntüle

@@ -68,7 +68,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-meta-instagram/templ


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mautrix-meta-messenger.md Dosyayı Görüntüle

@@ -82,7 +82,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-meta-messenger/templ


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mautrix-signal.md Dosyayı Görüntüle

@@ -68,7 +68,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-signal/templates/con


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 11
- 2
docs/configuring-playbook-bridge-mautrix-slack.md Dosyayı Görüntüle

@@ -44,12 +44,21 @@ Take a look at:


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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).


+ 14
- 1
docs/configuring-playbook-bridge-mautrix-telegram.md Dosyayı Görüntüle

@@ -22,7 +22,20 @@ matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mautrix-twitter.md Dosyayı Görüntüle

@@ -22,7 +22,20 @@ matrix_mautrix_twitter_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mautrix-whatsapp.md Dosyayı Görüntüle

@@ -36,7 +36,20 @@ If you want to activate the relay bot in a room, send `!wa set-relay`. To deacti


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mautrix-wsproxy.md Dosyayı Görüntüle

@@ -41,7 +41,20 @@ By default, you will need to create a CNAME record for `wsproxy`. See [Configuri


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mx-puppet-discord.md Dosyayı Görüntüle

@@ -18,7 +18,20 @@ matrix_mx_puppet_discord_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mx-puppet-groupme.md Dosyayı Görüntüle

@@ -14,7 +14,20 @@ matrix_mx_puppet_groupme_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mx-puppet-instagram.md Dosyayı Görüntüle

@@ -14,7 +14,20 @@ matrix_mx_puppet_instagram_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 11
- 2
docs/configuring-playbook-bridge-mx-puppet-slack.md Dosyayı Görüntüle

@@ -23,12 +23,21 @@ matrix_mx_puppet_slack_oauth_client_secret: "<SLACK_APP_CLIENT_SECRET>"


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
``` ```


**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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).


+ 14
- 1
docs/configuring-playbook-bridge-mx-puppet-steam.md Dosyayı Görüntüle

@@ -14,7 +14,20 @@ matrix_mx_puppet_steam_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-bridge-mx-puppet-twitter.md Dosyayı Görüntüle

@@ -25,7 +25,20 @@ matrix_mx_puppet_twitter_environment: ''


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 7
- 3
docs/configuring-playbook-bridge-postmoogle.md Dosyayı Görüntüle

@@ -49,18 +49,22 @@ You will also need to add several DNS records so that Postmoogle can send emails


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
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
``` ```


**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.


- if you change the bridge's bot password (`matrix_postmoogle_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_postmoogle_password` to let the bot know its new password
- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`


`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- If you change the bridge's bot password (`matrix_postmoogle_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_postmoogle_password` to let the bot know its new password.


## Usage ## Usage




+ 14
- 1
docs/configuring-playbook-bridge-wechat.md Dosyayı Görüntüle

@@ -14,7 +14,20 @@ matrix_wechat_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 14
- 1
docs/configuring-playbook-cactus-comments.md Dosyayı Görüntüle

@@ -63,7 +63,20 @@ If you've decided to use the default hostname, you won't need to do any extra DN


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 10
- 1
docs/configuring-playbook-client-cinny.md Dosyayı Görüntüle

@@ -42,4 +42,13 @@ If you've adjusted `matrix_client_cinny_hostname`, you will need to adjust your


## Installing ## Installing


After configuring the playbook and [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook and [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 10
- 1
docs/configuring-playbook-client-element-web.md Dosyayı Görüntüle

@@ -71,4 +71,13 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 10
- 1
docs/configuring-playbook-client-hydrogen.md Dosyayı Görüntüle

@@ -39,4 +39,13 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 10
- 1
docs/configuring-playbook-client-schildichat-web.md Dosyayı Görüntüle

@@ -69,4 +69,13 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 10
- 1
docs/configuring-playbook-dendrite.md Dosyayı Görüntüle

@@ -34,4 +34,13 @@ Alternatively, **if there is no pre-defined variable** for a Dendrite setting yo


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 8
- 2
docs/configuring-playbook-dimension.md Dosyayı Görüntüle

@@ -69,14 +69,20 @@ By default, you will need to create a CNAME record for `dimension`. See [Configu


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
``` ```


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.
**Notes**:


- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- 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.


## Jitsi domain ## Jitsi domain




+ 10
- 1
docs/configuring-playbook-dynamic-dns.md Dosyayı Görüntüle

@@ -25,7 +25,16 @@ matrix_dynamic_dns_domain_configurations:


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## Additional Reading ## Additional Reading




+ 12
- 2
docs/configuring-playbook-email2matrix.md Dosyayı Görüntüle

@@ -83,6 +83,16 @@ Refer to the official documentation [here](https://github.com/devture/email2matr


## Installing ## Installing


To enable Email2Matrix, run the [installation](installing.md) command (`--tags=setup-email2matrix,start`).
To enable Email2Matrix, run the playbook with [playbook tags](playbook-tags.md) as below:


After installation, you may wish to send a test email to the email address assigned to `mailbox1` (default: `mailbox1@matrix.example.com`) to make sure that Email2Matrix works as expected.
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-email2matrix,start
```

**Notes**:

- The shortcut commands with `just` program are also available: `just run-tags setup-email2matrix,start` or `just run-tags setup-all,start`

`just run-tags setup-email2matrix,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- After installation, you may wish to send a test email to the email address assigned to `mailbox1` (default: `mailbox1@matrix.example.com`) to make sure that Email2Matrix works as expected.

+ 16
- 1
docs/configuring-playbook-etherpad.md Dosyayı Görüntüle

@@ -44,7 +44,22 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the Etherpad admin user (`etherpad_admin_username`).

- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- If you change the Etherpad admin user's password (`etherpad_admin_password` in your `vars.yml` file) subsequently, the admin user's credentials on the homeserver won't be updated automatically. If you'd like to change the admin user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `etherpad_admin_password` to let the admin user know its new password.


## Usage ## Usage




+ 6
- 1
docs/configuring-playbook-jitsi.md Dosyayı Görüntüle

@@ -269,12 +269,17 @@ jitsi_disable_gravatar: false


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```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 run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

## Usage ## Usage


You can use the self-hosted Jitsi server in multiple ways: You can use the self-hosted Jitsi server in multiple ways:


+ 10
- 1
docs/configuring-playbook-ma1sd.md Dosyayı Görüntüle

@@ -131,7 +131,16 @@ matrix_ma1sd_configuration_extension_yaml: |


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## Troubleshooting ## Troubleshooting




+ 13
- 2
docs/configuring-playbook-matrix-authentication-service.md Dosyayı Görüntüle

@@ -288,9 +288,20 @@ If you've decided to use the default hostname, you won't need to do any extra DN


## Installing ## Installing


Now that you've [adjusted the playbook configuration](#adjusting-the-playbook-configuration) and [your DNS records](#adjusting-dns-records), you can run the [installation](installing.md) command: `just install-all`
Now that you've [adjusted the playbook configuration](#adjusting-the-playbook-configuration) and [your DNS records](#adjusting-dns-records), you can run the playbook with [playbook tags](playbook-tags.md) as below:


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.
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

**Notes**:

- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- 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).




+ 9
- 1
docs/configuring-playbook-matrix-corporal.md Dosyayı Görüntüle

@@ -116,8 +116,16 @@ To learn more about what the policy configuration, see the matrix-corporal docum


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command (`--tags=setup-all,start` or `--tags=setup-aux-files,setup-corporal,start`).
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags setup-aux-files,setup-corporal,start` or `just run-tags setup-all,start`

`just run-tags setup-aux-files,setup-corporal,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## Matrix Corporal files ## Matrix Corporal files




+ 10
- 1
docs/configuring-playbook-matrix-ldap-registration-proxy.md Dosyayı Görüntüle

@@ -34,4 +34,13 @@ matrix_ldap_registration_proxy_systemd_wanted_services_list_custom:


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 7
- 1
docs/configuring-playbook-matrix-registration.md Dosyayı Görüntüle

@@ -52,12 +52,16 @@ If you've decided to use the default hostname, you won't need to do any extra DN


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```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 run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## Usage ## Usage


@@ -91,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`

+ 14
- 1
docs/configuring-playbook-mautrix-bridges.md Dosyayı Görüntüle

@@ -93,7 +93,20 @@ You may wish to look at `roles/custom/matrix-bridge-mautrix-SERVICENAME/template


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-users-created,start
```

**Notes**:

- The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account.

- The shortcut commands with `just` program are also available: `just install-all` or `just setup-all`

`just install-all` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, 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




+ 5
- 1
docs/configuring-playbook-ntfy.md Dosyayı Görüntüle

@@ -50,12 +50,16 @@ By default, you will need to create a CNAME record for `ntfy`. See [Configuring


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```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 run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## Usage ## Usage




+ 10
- 1
docs/configuring-playbook-pantalaimon.md Dosyayı Görüntüle

@@ -18,4 +18,13 @@ The default configuration should suffice. For advanced configuration, you can ov


## 2. Installing ## 2. Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 6
- 1
docs/configuring-playbook-postgres-backup.md Dosyayı Görüntüle

@@ -29,8 +29,13 @@ Refer to the table below for additional configuration variables and their defaul


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```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 run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 10
- 1
docs/configuring-playbook-prometheus-grafana.md Dosyayı Görüntüle

@@ -55,7 +55,16 @@ By default, you will need to create a CNAME record for `stats`. See [Configuring


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## What does it do? ## What does it do?




+ 10
- 1
docs/configuring-playbook-prometheus-nginxlog.md Dosyayı Görüntüle

@@ -22,7 +22,16 @@ matrix_prometheus_nginxlog_exporter_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## Docker Image Compatibility ## Docker Image Compatibility




+ 10
- 1
docs/configuring-playbook-prometheus-postgres.md Dosyayı Görüntüle

@@ -12,7 +12,16 @@ prometheus_postgres_exporter_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## What does it do? ## What does it do?




+ 5
- 1
docs/configuring-playbook-rageshake.md Dosyayı Görüntüle

@@ -51,12 +51,16 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```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 run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## Usage ## Usage




+ 10
- 1
docs/configuring-playbook-rest-auth.md Dosyayı Görüntüle

@@ -26,4 +26,13 @@ matrix_synapse_password_config_localdb_enabled: false


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 10
- 1
docs/configuring-playbook-riot-web.md Dosyayı Görüntüle

@@ -30,4 +30,13 @@ There are a few options for handling this:


### Re-running the playbook ### Re-running the playbook


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 10
- 1
docs/configuring-playbook-shared-secret-auth.md Dosyayı Görüntüle

@@ -25,4 +25,13 @@ matrix_synapse_password_config_localdb_enabled: false


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 10
- 1
docs/configuring-playbook-sliding-sync-proxy.md Dosyayı Görüntüle

@@ -39,7 +39,16 @@ If you've decided to use the default hostname, you won't need to do any extra DN


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all`.
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


### External databases ### External databases




+ 5
- 1
docs/configuring-playbook-sygnal.md Dosyayı Görüntüle

@@ -77,12 +77,16 @@ If you've decided to reuse the `matrix.` domain, you won't need to do any extra


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```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 run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## Usage ## Usage




+ 10
- 1
docs/configuring-playbook-synapse-admin.md Dosyayı Görüntüle

@@ -48,7 +48,16 @@ If you've decided to use the default hostname, you won't need to do any extra DN


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command:
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## Usage ## Usage




+ 5
- 1
docs/configuring-playbook-synapse-auto-compressor.md Dosyayı Görüntüle

@@ -18,12 +18,16 @@ matrix_synapse_auto_compressor_enabled: true


## Installing ## Installing


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```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 run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


## Usage ## Usage




+ 10
- 1
docs/configuring-playbook-synapse-usage-exporter.md Dosyayı Görüntüle

@@ -50,4 +50,13 @@ If you've decided to use the default hostname, you won't need to do any extra DN


## Installing ## Installing


After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:

<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

+ 5
- 1
docs/configuring-playbook-user-verification-service.md Dosyayı Görüntüle

@@ -90,12 +90,16 @@ This will instruct UVS to verify the OpenID token against any domain given in a


## Installing ## Installing


After these variables have been set, run the [installation](installing.md) command to restart UVS:
After these variables have been set, run the playbook with [playbook tags](playbook-tags.md) as below to restart UVS:


```sh ```sh
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:


+ 9
- 2
docs/faq.md Dosyayı Görüntüle

@@ -269,13 +269,20 @@ matrix_server_fqn_element: "element.example.com"
matrix_server_fqn_etherpad: "etherpad.example.com" matrix_server_fqn_etherpad: "etherpad.example.com"
``` ```


After configuring the playbook, run the [installation](installing.md) command:
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
``` ```


**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`.
**Notes**:

- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)

- 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?




+ 3
- 1
docs/importing-synapse-media-store.md Dosyayı Görüntüle

@@ -18,6 +18,8 @@ As an alternative, you can perform a manual restore using the [AWS CLI tool](htt


Run this command (make sure to replace `<server-path-to-media_store>` with a path on your server): Run this command (make sure to replace `<server-path-to-media_store>` with a path on your server):


ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_media_store=<server-path-to-media_store>' --tags=import-synapse-media-store
```sh
ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_media_store=<server-path-to-media_store>' --tags=import-synapse-media-store
```


**Note**: `<server-path-to-media_store>` must be a file path to a `media_store` directory on the server (not on your local machine!). **Note**: `<server-path-to-media_store>` must be a file path to a `media_store` directory on the server (not on your local machine!).

+ 3
- 0
docs/maintenance-and-troubleshooting.md Dosyayı Görüntüle

@@ -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.


+ 2
- 0
docs/maintenance-checking-services.md Dosyayı Görüntüle

@@ -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.

+ 4
- 0
docs/maintenance-migrating.md Dosyayı Görüntüle

@@ -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)


+ 2
- 0
docs/maintenance-synapse.md Dosyayı Görüntüle

@@ -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).


+ 12
- 2
docs/registering-users.md Dosyayı Görüntüle

@@ -112,10 +112,20 @@ For Dendrite:
matrix_dendrite_client_api_registration_disabled: false matrix_dendrite_client_api_registration_disabled: false
``` ```


After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all`
After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:


If you're opening up registrations publicly like this, you might also wish to [configure CAPTCHA protection](configuring-captcha.md).
<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
```sh
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
```

**Notes**:

- The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`

`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)


- If you're opening up registrations publicly like this, you might also wish to [configure CAPTCHA protection](configuring-captcha.md).


## Adding/Removing Administrator privileges to an existing user ## Adding/Removing Administrator privileges to an existing user




Yükleniyor…
İptal
Kaydet