mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2026-07-16 19:53:53 +03:00
Compare commits
258 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| b8c6ee200f | |||
| 44f269001b | |||
| 7a4ff93263 | |||
| 7ba6614c08 | |||
| 5083de4964 | |||
| c254bd8932 | |||
| 0b5b472425 | |||
| 24f5d66d4d | |||
| e3faabf125 | |||
| 129f5fda20 | |||
| a77b8f6eab | |||
| 267d578393 | |||
| b68674d5da | |||
| ceb178008f | |||
| 7380cbdc3c | |||
| 97077e2f13 | |||
| 4d6b68a5da | |||
| 54020894b4 | |||
| e751673b0d | |||
| ace4edb01b | |||
| bb225546bd | |||
| ca301ffde0 | |||
| ba0fd18361 | |||
| 5d19e75236 | |||
| b2fb403d31 | |||
| 5ff45d47c3 | |||
| 2241a2dedb | |||
| 6768ada899 | |||
| 7ccc9c515e | |||
| 6e4992a2fe | |||
| 62b5375815 | |||
| 98269653b2 | |||
| dc16f09e78 | |||
| d9bee18ddd | |||
| c12f5947c9 | |||
| 84a0053191 | |||
| 73a52c8a24 | |||
| 7a719aed5b | |||
| a1cdd367f5 | |||
| 88d13ff3d6 | |||
| 13f3d771c0 | |||
| dd6b4444de | |||
| 0d5b0d77b8 | |||
| 145403217c | |||
| 0e7c8af2ac | |||
| 39dd69d82b | |||
| 5da2d0e4a5 | |||
| b2788f690a | |||
| 7897d63660 | |||
| 23783f87bc | |||
| eb0af09bf5 | |||
| f93616c06e | |||
| 376786b997 | |||
| de1ba73f40 | |||
| d2f1fa74cc | |||
| 62792b3670 | |||
| a039cc5982 | |||
| 5a9e34c563 | |||
| 534631c1e7 | |||
| 635bb61424 | |||
| c7819f576a | |||
| 435aecc1a8 | |||
| a03faef70f | |||
| 94d8e28306 | |||
| 6b4b7647e4 | |||
| 90d486c4f6 | |||
| 2d436491c6 | |||
| 8b9fe4ce37 | |||
| 639996d3a0 | |||
| f8539f4cbf | |||
| a4915c0b9e | |||
| deb19c46a8 | |||
| 2fe710bdb4 | |||
| ee38b3aac2 | |||
| 506d4ab4c9 | |||
| 44cfd16036 | |||
| b32272ef40 | |||
| d0f877fb86 | |||
| bb1cbdb111 | |||
| f8ea906c19 | |||
| 7f4691aabb | |||
| 85484aed85 | |||
| fa8c764708 | |||
| fba605de34 | |||
| 0b966a4500 | |||
| 93caf43948 | |||
| aa97075f11 | |||
| 8368b21e6d | |||
| e6a8de7cec | |||
| 7d2a2c40c9 | |||
| 7ae2f46bf7 | |||
| 7833006b07 | |||
| eb6328e5e9 | |||
| 80c2624454 | |||
| 0f7f60372f | |||
| fc473797cd | |||
| 8250b6d088 | |||
| b57ac50c81 | |||
| e6e0df3d32 | |||
| 19a775ef7e | |||
| 1d14b599b2 | |||
| 79d3d3c9c6 | |||
| 2519a81597 | |||
| 931aa6cf57 | |||
| c24bcc8158 | |||
| 25cf21da42 | |||
| 68fe9c176f | |||
| 2c57bd3b90 | |||
| d8742b0624 | |||
| e280b5819f | |||
| 8f3e76597f | |||
| c4012389d4 | |||
| 94bf7a90ab | |||
| a3123b5456 | |||
| 22d6fd0be2 | |||
| f750cc01b4 | |||
| d28497df0e | |||
| 373bf99c86 | |||
| b463dd02bb | |||
| 044dbc5de5 | |||
| ed0994fcdd | |||
| c070752c17 | |||
| d1d116b519 | |||
| 6735320341 | |||
| 8bd2d473b7 | |||
| 2b12dae59a | |||
| 8a9bb8cfe3 | |||
| 5df06de359 | |||
| e52c261888 | |||
| b55ad8d097 | |||
| 173a60101f | |||
| 41a046a3d4 | |||
| 3b3f186c47 | |||
| 8c15c46936 | |||
| f75ce847b4 | |||
| 08cd63fe67 | |||
| 203650bc73 | |||
| df3d0ceae5 | |||
| fe40516804 | |||
| 46adef0344 | |||
| c146892b25 | |||
| 0a0259c0cf | |||
| aa1b130a23 | |||
| ee1cd217a8 | |||
| 4f9346e182 | |||
| b897b45191 | |||
| 693fbb08aa | |||
| 1789ea2083 | |||
| 00f39e3b1d | |||
| 4aca22dd96 | |||
| 2879a01105 | |||
| 42c173c0b3 | |||
| 20a2395403 | |||
| 1b9b1119a1 | |||
| 2d7058fa59 | |||
| 44c8736c08 | |||
| a50e7960d8 | |||
| d2252db4fe | |||
| a4ddba3989 | |||
| d61979a0b9 | |||
| 3fed0f1bb4 | |||
| e43add179b | |||
| 129d4e74b4 | |||
| 5c390e137f | |||
| 682eb2c280 | |||
| 4fae640b6c | |||
| adcae966ed | |||
| 0a46beb76c | |||
| 7bee5f06dc | |||
| b67f7bd3fe | |||
| 08c733d2e3 | |||
| 424c323d03 | |||
| 11cd178cb2 | |||
| 6f57ab8ba1 | |||
| 4f00ad9bd4 | |||
| 753f8ca7db | |||
| d06094ffc3 | |||
| dd37011ffb | |||
| e3b37ac350 | |||
| be68aaa870 | |||
| 36e94e4df7 | |||
| 37d8cf4f2c | |||
| fd340a14f9 | |||
| 73f8ca75b3 | |||
| 81e156b4bf | |||
| 6ee65072ef | |||
| 8b13017281 | |||
| e0f37e3912 | |||
| 4ff28586f4 | |||
| 19bcdc78fd | |||
| 914dd3ed62 | |||
| 3250de7842 | |||
| af4d379573 | |||
| 12e63739b9 | |||
| 6b76368a9c | |||
| b87fcc4674 | |||
| 00e5aed0eb | |||
| 6926a04e07 | |||
| 50408d699f | |||
| 4bf6093a5d | |||
| f0fb23dfa9 | |||
| 8e41f04368 | |||
| b863de00e8 | |||
| 4f5904db0a | |||
| 802f687513 | |||
| b7b5dbf9c7 | |||
| a79b8034e6 | |||
| 9acdc445a8 | |||
| 731804ba32 | |||
| b7969138dd | |||
| ec6e006b42 | |||
| 36f3d4c4a5 | |||
| fda7664a40 | |||
| 9d143f8865 | |||
| 67663be7a9 | |||
| 45c3b751d9 | |||
| ce8beb5e9d | |||
| bd6e08a93e | |||
| 550fc03d60 | |||
| e1db9c7876 | |||
| 906de0a1a4 | |||
| 9342507f8a | |||
| 4fd6183273 | |||
| 0ce46bae94 | |||
| af37ca09cc | |||
| 28165b5892 | |||
| 700976c47c | |||
| 66eabbb0ea | |||
| 61a29cf718 | |||
| 47a4037ea2 | |||
| 93ec9095d5 | |||
| 92b7fed717 | |||
| a7be5a2088 | |||
| 738bff7a00 | |||
| 6b36fd5a03 | |||
| a9faa9e306 | |||
| 9634cc3f79 | |||
| 551c802122 | |||
| 3c7e67c7fc | |||
| 612fac5bce | |||
| f3151efa08 | |||
| 971c5b954c | |||
| 079169809f | |||
| 60eb52d791 | |||
| ee0e74f1cf | |||
| f92c5fee18 | |||
| a5ebb77eeb | |||
| 27826e69ca | |||
| 5125cb219c | |||
| 8afcb2ee2c | |||
| c93bdba01c | |||
| 123d1f4399 | |||
| c4e4a83a31 | |||
| ae44096ecb | |||
| b4006bc7ea | |||
| 5359313246 | |||
| 4a4ca67465 | |||
| 0f40fe6270 |
@@ -0,0 +1,13 @@
|
||||
# SPDX-FileCopyrightText: 2025 Jonah Aragon
|
||||
#
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
FROM ghcr.io/devture/ansible:11.6.0-r0-0
|
||||
|
||||
# Install additional packages
|
||||
RUN apk add --no-cache \
|
||||
pwgen
|
||||
|
||||
# Preserve command history across container restarts
|
||||
RUN SNIPPET="export HISTFILE=/commandhistory/.ash_history" \
|
||||
&& echo "$SNIPPET" >> "/root/.profile"
|
||||
@@ -0,0 +1,27 @@
|
||||
{
|
||||
"name": "matrix-docker-ansible-deploy",
|
||||
"build": {
|
||||
"dockerfile": "Dockerfile",
|
||||
"context": ".."
|
||||
},
|
||||
"postCreateCommand": {
|
||||
"Fix Volume Permissions": "chown -R $(whoami): /commandhistory"
|
||||
},
|
||||
"mounts": [
|
||||
{
|
||||
"source": "matrix-docker-ansible-deploy-bashhistory",
|
||||
"target": "/commandhistory",
|
||||
"type": "volume"
|
||||
}
|
||||
],
|
||||
"customizations": {
|
||||
"vscode": {
|
||||
"extensions": [
|
||||
"EditorConfig.EditorConfig",
|
||||
"redhat.ansible",
|
||||
"redhat.vscode-yaml",
|
||||
"ms-python.python"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,3 @@
|
||||
SPDX-FileCopyrightText: 2025 Jonah Aragon
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
@@ -25,9 +25,34 @@
|
||||
"https://github.com/devture/com.devture.ansible.role{/,}**",
|
||||
"https://github.com/mother-of-all-self-hosting{/,}**"
|
||||
]
|
||||
},
|
||||
{
|
||||
"description": "mautrix images are dual-tagged (v0.YYMM.PATCH and vYY.MM[.PATCH]). Stick to the v0 scheme: it matches the git tags (needed for self-building) and has a consistent number of components (the calver tags do not, which makes Renovate stop offering updates).",
|
||||
"matchPackageNames": [
|
||||
"dock.mau.dev/mautrix/**"
|
||||
],
|
||||
"allowedVersions": "/^v0\\./"
|
||||
},
|
||||
{
|
||||
"matchFileNames": [
|
||||
".github/workflows/close-stale-issues.yml",
|
||||
".github/workflows/lock-threads.yml",
|
||||
".github/workflows/matrix.yml",
|
||||
".github/workflows/update-translations.yml",
|
||||
"flake.lock",
|
||||
"i18n/requirements.txt",
|
||||
"mise.toml"
|
||||
],
|
||||
"automerge": true
|
||||
}
|
||||
],
|
||||
"pre-commit": {
|
||||
"enabled": true
|
||||
},
|
||||
"nix": {
|
||||
"enabled": true,
|
||||
"lockFileMaintenance": {
|
||||
"enabled": true
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -26,10 +26,10 @@ jobs:
|
||||
run: pacman -Sy --noconfirm git
|
||||
|
||||
- name: Check out
|
||||
uses: actions/checkout@v6
|
||||
uses: actions/checkout@v7
|
||||
|
||||
- name: Restore prek cache
|
||||
uses: actions/cache@v5
|
||||
uses: actions/cache@v6
|
||||
with:
|
||||
path: var/prek
|
||||
key: arch-prek-v1-${{ hashFiles('.pre-commit-config.yaml') }}
|
||||
|
||||
@@ -24,7 +24,7 @@ jobs:
|
||||
name: Update translations
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v6
|
||||
- uses: actions/checkout@v7
|
||||
|
||||
- uses: actions/setup-python@v6
|
||||
with:
|
||||
@@ -32,7 +32,7 @@ jobs:
|
||||
|
||||
# Setting up recommended prerequisites
|
||||
# See: i18n/README.md
|
||||
- uses: astral-sh/setup-uv@v8.1.0
|
||||
- uses: astral-sh/setup-uv@v8.3.2
|
||||
- uses: extractions/setup-just@v4
|
||||
|
||||
# TODO: optimize when we start publishing translations and integrate a Weblate instance
|
||||
|
||||
@@ -15,7 +15,7 @@ repos:
|
||||
- id: trailing-whitespace
|
||||
- id: end-of-file-fixer
|
||||
- repo: https://github.com/codespell-project/codespell
|
||||
rev: v2.4.2
|
||||
rev: v2.4.3
|
||||
hooks:
|
||||
- id: codespell
|
||||
args: ["--skip=*.po,*.pot,i18n/"]
|
||||
@@ -24,7 +24,7 @@ repos:
|
||||
hooks:
|
||||
- id: reuse
|
||||
- repo: https://github.com/ansible/ansible-lint
|
||||
rev: v26.4.0
|
||||
rev: v26.6.0
|
||||
hooks:
|
||||
- id: ansible-lint
|
||||
files: '^roles/custom/'
|
||||
|
||||
@@ -1,5 +1,16 @@
|
||||
---
|
||||
extends: default
|
||||
|
||||
# Keep this custom configuration compatible with ansible-lint's `yaml` rule.
|
||||
# See https://docs.ansible.com/projects/lint/rules/yaml/#yamllint-configuration
|
||||
rules:
|
||||
braces:
|
||||
min-spaces-inside: 0
|
||||
max-spaces-inside: 1
|
||||
comments:
|
||||
min-spaces-from-content: 1
|
||||
comments-indentation: false
|
||||
line-length: disable
|
||||
octal-values:
|
||||
forbid-explicit-octal: true
|
||||
forbid-implicit-octal: true
|
||||
|
||||
+201
@@ -1,3 +1,204 @@
|
||||
# 2026-07-16
|
||||
|
||||
## (Backward Compatibility Break) Bridge variables have been renamed
|
||||
|
||||
All bridge roles (`roles/custom/matrix-bridge-*`) now use a uniform variable naming scheme, where the variable prefix matches the role directory name. This adopts the naming policy proposed in [#4705](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/4705) and requested in [#5096](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/5096).
|
||||
|
||||
Previously, bridge variable prefixes were all over the place (`matrix_mautrix_telegram_*`, `matrix_heisenbridge_*`, `matrix_steam_bridge_*`, etc.). Now, they all follow the same pattern that bot roles (`matrix_bot_<name>_*`) have been using for years: the `matrix-bridge-mautrix-telegram` role uses `matrix_bridge_mautrix_telegram_*` variables, the `matrix-bridge-steam` role uses `matrix_bridge_steam_*` variables, and so on.
|
||||
|
||||
Only Ansible variables were renamed. Systemd service names, container names, `/matrix/*` directories, database names and usernames, and appservice registration contents (tokens, bot usernames) all remain the same. No data migration is necessary and bridges keep working as before, once you rename the variables in your `vars.yml` configuration file.
|
||||
|
||||
The playbook will let you know if your configuration still uses old-style variable names.
|
||||
|
||||
Here is the full rename map:
|
||||
|
||||
| Old variable prefix | New variable prefix |
|
||||
|---------------------|---------------------|
|
||||
| `matrix_appservice_discord_` | `matrix_bridge_appservice_discord_` |
|
||||
| `matrix_appservice_irc_` | `matrix_bridge_appservice_irc_` |
|
||||
| `matrix_beeper_linkedin_` | `matrix_bridge_beeper_linkedin_` |
|
||||
| `matrix_heisenbridge_` | `matrix_bridge_heisenbridge_` |
|
||||
| `matrix_hookshot_` | `matrix_bridge_hookshot_` |
|
||||
| `matrix_mautrix_androidsms_` | `matrix_bridge_mautrix_wsproxy_androidsms_` |
|
||||
| `matrix_mautrix_bluesky_` | `matrix_bridge_mautrix_bluesky_` |
|
||||
| `matrix_mautrix_discord_` | `matrix_bridge_mautrix_discord_` |
|
||||
| `matrix_mautrix_gmessages_` | `matrix_bridge_mautrix_gmessages_` |
|
||||
| `matrix_mautrix_googlechat_` | `matrix_bridge_mautrix_googlechat_` |
|
||||
| `matrix_mautrix_gvoice_` | `matrix_bridge_mautrix_gvoice_` |
|
||||
| `matrix_mautrix_imessage_` | `matrix_bridge_mautrix_wsproxy_imessage_` |
|
||||
| `matrix_mautrix_meta_instagram_` | `matrix_bridge_mautrix_meta_instagram_` |
|
||||
| `matrix_mautrix_meta_messenger_` | `matrix_bridge_mautrix_meta_messenger_` |
|
||||
| `matrix_mautrix_signal_` | `matrix_bridge_mautrix_signal_` |
|
||||
| `matrix_mautrix_slack_` | `matrix_bridge_mautrix_slack_` |
|
||||
| `matrix_mautrix_telegram_` | `matrix_bridge_mautrix_telegram_` |
|
||||
| `matrix_mautrix_twitter_` | `matrix_bridge_mautrix_twitter_` |
|
||||
| `matrix_mautrix_whatsapp_` | `matrix_bridge_mautrix_whatsapp_` |
|
||||
| `matrix_mautrix_wsproxy_` | `matrix_bridge_mautrix_wsproxy_` |
|
||||
| `matrix_meshtastic_relay_` | `matrix_bridge_meshtastic_relay_` |
|
||||
| `matrix_mx_puppet_groupme_` | `matrix_bridge_mx_puppet_groupme_` |
|
||||
| `matrix_mx_puppet_steam_` | `matrix_bridge_mx_puppet_steam_` |
|
||||
| `matrix_postmoogle_` | `matrix_bridge_postmoogle_` |
|
||||
| `matrix_rustpush_bridge_` | `matrix_bridge_rustpush_` |
|
||||
| `matrix_sms_bridge_` | `matrix_bridge_sms_` |
|
||||
| `matrix_steam_bridge_` | `matrix_bridge_steam_` |
|
||||
| `matrix_wechat_` | `matrix_bridge_wechat_` |
|
||||
|
||||
A few special cases beyond the prefix map:
|
||||
|
||||
- `matrix_mautrix_signal_wsproxy_syncproxy_connection_string` (a variable of the mautrix-wsproxy role, despite its name) is now `matrix_bridge_mautrix_wsproxy_syncproxy_connection_string`
|
||||
- `matrix_playbook_migration_matrix_postmoogle_migration_validation_enabled` is now `matrix_playbook_migration_matrix_bridge_postmoogle_migration_validation_enabled`
|
||||
|
||||
You can update your `vars.yml` file automatically with this `sed` command (on macOS, use `sed -i ''` instead of `sed -i`):
|
||||
|
||||
```sh
|
||||
sed -i \
|
||||
-e 's/matrix_appservice_discord_/matrix_bridge_appservice_discord_/g' \
|
||||
-e 's/matrix_appservice_irc_/matrix_bridge_appservice_irc_/g' \
|
||||
-e 's/matrix_beeper_linkedin_/matrix_bridge_beeper_linkedin_/g' \
|
||||
-e 's/matrix_heisenbridge_/matrix_bridge_heisenbridge_/g' \
|
||||
-e 's/matrix_hookshot_/matrix_bridge_hookshot_/g' \
|
||||
-e 's/matrix_mautrix_androidsms_/matrix_bridge_mautrix_wsproxy_androidsms_/g' \
|
||||
-e 's/matrix_mautrix_bluesky_/matrix_bridge_mautrix_bluesky_/g' \
|
||||
-e 's/matrix_mautrix_discord_/matrix_bridge_mautrix_discord_/g' \
|
||||
-e 's/matrix_mautrix_gmessages_/matrix_bridge_mautrix_gmessages_/g' \
|
||||
-e 's/matrix_mautrix_googlechat_/matrix_bridge_mautrix_googlechat_/g' \
|
||||
-e 's/matrix_mautrix_gvoice_/matrix_bridge_mautrix_gvoice_/g' \
|
||||
-e 's/matrix_mautrix_imessage_/matrix_bridge_mautrix_wsproxy_imessage_/g' \
|
||||
-e 's/matrix_mautrix_meta_instagram_/matrix_bridge_mautrix_meta_instagram_/g' \
|
||||
-e 's/matrix_mautrix_meta_messenger_/matrix_bridge_mautrix_meta_messenger_/g' \
|
||||
-e 's/matrix_mautrix_signal_wsproxy_syncproxy_connection_string/matrix_bridge_mautrix_wsproxy_syncproxy_connection_string/g' \
|
||||
-e 's/matrix_mautrix_signal_/matrix_bridge_mautrix_signal_/g' \
|
||||
-e 's/matrix_mautrix_slack_/matrix_bridge_mautrix_slack_/g' \
|
||||
-e 's/matrix_mautrix_telegram_/matrix_bridge_mautrix_telegram_/g' \
|
||||
-e 's/matrix_mautrix_twitter_/matrix_bridge_mautrix_twitter_/g' \
|
||||
-e 's/matrix_mautrix_whatsapp_/matrix_bridge_mautrix_whatsapp_/g' \
|
||||
-e 's/matrix_mautrix_wsproxy_/matrix_bridge_mautrix_wsproxy_/g' \
|
||||
-e 's/matrix_meshtastic_relay_/matrix_bridge_meshtastic_relay_/g' \
|
||||
-e 's/matrix_mx_puppet_groupme_/matrix_bridge_mx_puppet_groupme_/g' \
|
||||
-e 's/matrix_mx_puppet_steam_/matrix_bridge_mx_puppet_steam_/g' \
|
||||
-e 's/matrix_postmoogle_/matrix_bridge_postmoogle_/g' \
|
||||
-e 's/matrix_rustpush_bridge_/matrix_bridge_rustpush_/g' \
|
||||
-e 's/matrix_sms_bridge_/matrix_bridge_sms_/g' \
|
||||
-e 's/matrix_steam_bridge_/matrix_bridge_steam_/g' \
|
||||
-e 's/matrix_wechat_/matrix_bridge_wechat_/g' \
|
||||
-e 's/matrix_playbook_migration_matrix_postmoogle_migration_validation_enabled/matrix_playbook_migration_matrix_bridge_postmoogle_migration_validation_enabled/g' \
|
||||
vars.yml
|
||||
```
|
||||
|
||||
The `sed` command only replaces prefixes followed by an underscore, so values that intentionally match old prefixes (like the default database names, e.g. `matrix_mautrix_telegram`) are not affected.
|
||||
|
||||
**Note**: if you have defined your own custom variables whose names embed an old prefix (e.g. `vault_matrix_postmoogle_password` referencing a secret in an Ansible Vault file), the `sed` command renames such references too. Either rename your custom variables to match (including their definitions in encrypted vault files, which `sed` cannot reach), or revert those spots manually.
|
||||
|
||||
# 2026-07-15
|
||||
|
||||
## Google Voice bridging
|
||||
|
||||
The playbook can now bridge [Google Voice](https://voice.google.com/) via the [mautrix-gvoice](https://github.com/mautrix/gvoice) bridge. Text and media flow both ways, and portal rooms build themselves for your recent conversations.
|
||||
|
||||
Login is by cookie, not a paired phone: you copy the cookies from a browser signed in to voice.google.com and hand them to the bot. Google expires them on its own schedule, so expect to log in again every so often. See [Setting up Mautrix Google Voice bridging](./docs/configuring-playbook-bridge-mautrix-gvoice.md) to get started.
|
||||
|
||||
## matrix-appservice-kakaotalk has been removed from the playbook
|
||||
|
||||
The [matrix-appservice-kakaotalk](./docs/configuring-playbook-bridge-appservice-kakaotalk.md) bridge has been removed from the playbook. This component could only be installed by self-building its source code, and its upstream repository has become unreachable, which makes installation impossible. The bridge was also based on the unmaintained node-kakao library, and there have been reports that using it may get KakaoTalk accounts banned.
|
||||
|
||||
The playbook will let you know if you're using any `matrix_appservice_kakaotalk_*` variables. You'll need to remove them from `vars.yml` and potentially [uninstall the component manually](./docs/configuring-playbook-bridge-appservice-kakaotalk.md#uninstalling-the-component-manually).
|
||||
|
||||
## Dedicated CAPTCHA variables for Matrix Authentication Service
|
||||
|
||||
[Matrix Authentication Service](./docs/configuring-playbook-matrix-authentication-service.md) can now be protected with CAPTCHA (ReCaptcha v2, Cloudflare Turnstile, or hCaptcha) via dedicated variables, instead of going through `matrix_authentication_service_configuration_extension_yaml`. See the [captcha documentation](./docs/configuring-captcha.md#matrix-authentication-service) for details.
|
||||
|
||||
# 2026-07-14
|
||||
|
||||
## The playbook no longer ships a custom welcome page for Element Web
|
||||
|
||||
Element Web [redesigned its welcome page](https://github.com/element-hq/element-web/pull/33211) (the screen shown at `/#/welcome` before logging in) into a built-in component and no longer loads a custom `welcome.html` file by default. Since the playbook upgraded to an Element Web version containing that change (spring 2026), the custom welcome page the playbook installed (and the variables customizing it) had silently stopped having any effect.
|
||||
|
||||
The playbook now embraces the new upstream behavior and no longer ships its own `welcome.html`. The following variables have been removed and the playbook will let you know if you're still using them: `matrix_client_element_welcome_headline`, `matrix_client_element_welcome_text`, `matrix_client_element_welcome_logo_link` and `matrix_client_element_page_template_welcome_path`.
|
||||
|
||||
Most welcome page customizations keep working, because they go through Element Web's branding configuration, which the new welcome page still honors:
|
||||
|
||||
- a custom logo, via `matrix_client_element_welcome_logo` (or `matrix_client_element_branding_auth_header_logo_url`)
|
||||
- a custom background, via `matrix_client_element_branding_welcome_background_url`
|
||||
|
||||
If you need a fully custom welcome page, you can self-host an HTML page and point Element Web at it, like this:
|
||||
|
||||
```yaml
|
||||
matrix_client_element_configuration_extension_json: |
|
||||
{
|
||||
"embedded_pages": {
|
||||
"welcome_url": "https://example.com/my-welcome.html"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
## BorgBackup now includes Synapse's local thumbnails
|
||||
|
||||
For Synapse servers, the built-in [BorgBackup](./docs/configuring-playbook-backup-borg.md) integration no longer excludes the media store's `local_thumbnails` directory from backups.
|
||||
|
||||
Synapse only generates thumbnails of local media at upload time (unless `dynamic_thumbnails` is enabled, which the playbook does not do), and there is no tooling to regenerate them. Restoring a backup made with the previous exclusion list therefore left all previously uploaded local images without thumbnails. The [official Synapse backup guide](https://element-hq.github.io/synapse/latest/usage/administration/backups.html) recommends backing this directory up, and the playbook now follows that recommendation.
|
||||
|
||||
Expect your backups to grow somewhat, depending on how much image media your local users have uploaded. If you prefer the old behavior, you can redefine `backup_borg_location_exclude_patterns` in your `vars.yml`.
|
||||
|
||||
# 2026-07-12
|
||||
|
||||
## matrix-registration-bot has been removed from the playbook
|
||||
|
||||
The [matrix-registration-bot](./docs/configuring-playbook-bot-matrix-registration-bot.md) service has been removed from the playbook, as it has been unmaintained.
|
||||
|
||||
The playbook will let you know if you're using any `matrix_bot_matrix_registration_bot_*` variables. You'll need to remove them from `vars.yml` and potentially [uninstall the component manually](./docs/configuring-playbook-bot-matrix-registration-bot.md#uninstalling-the-component-manually).
|
||||
|
||||
## Continuwuity v26 no longer supports LDAP
|
||||
|
||||
The playbook now installs [Continuwuity](./docs/configuring-playbook-continuwuity.md) v26, a major upgrade from the v0.5.x series which **removes LDAP authentication support** (see the [v26.6.0 release notes](https://forgejo.ellis.link/continuwuation/continuwuity/releases/tag/v26.6.0)).
|
||||
|
||||
The playbook never exposed dedicated variables for Continuwuity's LDAP support, so most people are unaffected. However, if you had enabled LDAP via `matrix_continuwuity_environment_variables_extension` or a custom configuration template, you'll need to migrate to another authentication method, such as the newly introduced [OpenID Connect support](https://continuwuity.org/guides/oidc).
|
||||
|
||||
# 2026-06-29
|
||||
|
||||
## Support for running on Synology DSM
|
||||
|
||||
Thanks to [cksit](https://github.com/cksit), the playbook can now run on [Synology DSM](https://www.synology.com/dsm) 7 and later.
|
||||
|
||||
Synology hosts are detected automatically (via `/etc/synoinfo.conf`), so other systems are unaffected. On DSM, the playbook uses the platform's native user management (`synouser`/`synogroup`), works around a Docker SDK incompatibility, and installs a small boot-fix service that handles a few DSM-specific boot quirks.
|
||||
|
||||
To get started, see the new [Configuring Synology DSM](./docs/configuring-playbook-synology.md) documentation page.
|
||||
|
||||
## Mautrix bridges now expose their API (for Mautrix Manager and similar tools)
|
||||
|
||||
The playbook now exposes the HTTP API of each [mautrix](https://github.com/mautrix) bridge, so tools like [Mautrix Manager](https://github.com/mautrix/manager) can help you log into them. This is especially useful for [mautrix-gmessages](./docs/configuring-playbook-bridge-mautrix-gmessages.md): Google has removed its QR-code login, leaving a [manual cookie-extraction flow](https://docs.mau.fi/bridges/go/gmessages/authentication.html) that tools like Mautrix Manager can streamline.
|
||||
|
||||
The API is exposed at `https://matrix.example.com/bridges/SERVICENAME` (for example, `https://matrix.example.com/bridges/gmessages`) and is advertised via a new `/.well-known/matrix/mautrix` file, so compatible tools can discover your bridges automatically. Such tools authenticate with your own Matrix access token, so no bridge secret needs to be shared with them.
|
||||
|
||||
This affects all mautrix bridges based on the new bridge framework (bluesky, gmessages, meta-instagram, meta-messenger, signal, slack, telegram, twitter and whatsapp) and is enabled by default.
|
||||
|
||||
To learn more (including how to turn it off), see the [Expose the bridge's API](./docs/configuring-playbook-bridge-mautrix-bridges.md#expose-the-bridges-api-for-mautrix-manager-and-similar-tools) section on our common mautrix bridges documentation page.
|
||||
|
||||
# 2026-06-28
|
||||
|
||||
## baibot now supports Venice, our recommended provider
|
||||
|
||||
[baibot](./docs/configuring-playbook-bot-baibot.md) now ships a preset for the [Venice](./docs/configuring-playbook-bot-baibot.md#venice) provider, and it's the one we recommend. It's the most capable provider baibot supports (text generation with vision, file inputs and web search, speech-to-text, text-to-speech, and image generation and editing), and the only one that runs inference with no logging and no training on your data.
|
||||
|
||||
Enabling it takes a preset toggle and an API key:
|
||||
|
||||
```yaml
|
||||
matrix_bot_baibot_config_agents_static_definitions_venice_enabled: true
|
||||
|
||||
matrix_bot_baibot_config_agents_static_definitions_venice_config_api_key: "YOUR_API_KEY_HERE"
|
||||
```
|
||||
|
||||
[OpenAI](https://openai.com/) and baibot's other providers remain fully supported. To get started, see the [Setting up baibot](./docs/configuring-playbook-bot-baibot.md#venice) documentation page.
|
||||
|
||||
# 2026-06-24
|
||||
|
||||
## Support for bridging to iMessage via RustPush
|
||||
|
||||
Thanks to [jasonlaguidice](https://github.com/jasonlaguidice), the playbook now supports bridging to [iMessage](https://support.apple.com/messages) via a new [RustPush](https://github.com/OpenBubbles/rustpush)-based bridge ([jasonlaguidice/imessage](https://github.com/jasonlaguidice/imessage)).
|
||||
|
||||
Unlike the existing [mautrix-wsproxy](./docs/configuring-playbook-bridge-mautrix-wsproxy.md) iMessage bridge, this one talks directly to Apple's push notification service, so it needs neither a running Mac nor a wsproxy on the homeserver. Each user supplies a hardware key extracted from a Mac through the bridge bot's login flow.
|
||||
|
||||
To learn more, see our [Setting up RustPush (iMessage) bridging](./docs/configuring-playbook-bridge-rustpush.md) documentation page.
|
||||
|
||||
# 2026-05-24
|
||||
|
||||
## matrix-ldap-registration-proxy has been removed from the playbook
|
||||
|
||||
@@ -2,11 +2,14 @@
|
||||
#
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
.PHONY: roles lint
|
||||
.PHONY: roles lint add-inventory-host
|
||||
|
||||
help: ## Show this help.
|
||||
@grep -F -h "##" $(MAKEFILE_LIST) | grep -v grep | sed -e 's/\\$$//' | sed -e 's/##//'
|
||||
|
||||
add-inventory-host: ## Adds a new host to the inventory, creating the inventory files if necessary (e.g. `make add-inventory-host domain=example.com ip=1.2.3.4`)
|
||||
@./bin/add-inventory-host.sh "$(domain)" "$(ip)"
|
||||
|
||||
roles: ## Pull roles
|
||||
rm -rf roles/galaxy
|
||||
ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force
|
||||
|
||||
@@ -65,9 +65,10 @@ Web clients for Matrix that you can host on your own domains.
|
||||
| [Element Web](https://github.com/element-hq/element-web) | ✅ | Default Matrix web client, configured to connect to your own Synapse server | [Link](docs/configuring-playbook-client-element-web.md) |
|
||||
| [Hydrogen](https://github.com/element-hq/hydrogen-web) | ❌ | Lightweight Matrix client with legacy and mobile browser support | [Link](docs/configuring-playbook-client-hydrogen.md) |
|
||||
| [Cinny](https://github.com/ajbura/cinny) | ❌ | Simple, elegant and secure web client | [Link](docs/configuring-playbook-client-cinny.md) |
|
||||
| [Sable](https://github.com/7w1/sable) | ❌ | Simple, elegant and secure web client | [Link](docs/configuring-playbook-client-sable.md) |
|
||||
| [Sable](https://github.com/SableClient/Sable) | ❌ | Simple, elegant and secure web client | [Link](docs/configuring-playbook-client-sable.md) |
|
||||
| [SchildiChat Web](https://schildi.chat/) | ❌ | Based on Element Web, with a more traditional instant messaging experience | [Link](docs/configuring-playbook-client-schildichat-web.md) |
|
||||
| [FluffyChat Web](https://fluffychat.im/) | ❌ | The cutest messenger in Matrix | [Link](docs/configuring-playbook-client-fluffychat-web.md) |
|
||||
| [Commet](https://github.com/commetchat/commet) | ❌ | Matrix web client | [Link](docs/configuring-playbook-client-commet.md) |
|
||||
|
||||
### Server Components
|
||||
|
||||
@@ -115,8 +116,10 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
| [mautrix-slack](https://github.com/mautrix/slack) | ❌ | Bridge to [Slack](https://slack.com/) | [Link](docs/configuring-playbook-bridge-mautrix-slack.md) |
|
||||
| [mautrix-telegram](https://github.com/mautrix/telegram) | ❌ | Bridge to [Telegram](https://telegram.org/) | [Link](docs/configuring-playbook-bridge-mautrix-telegram.md) |
|
||||
| [mautrix-gmessages](https://github.com/mautrix/gmessages) | ❌ | Bridge to [Google Messages](https://messages.google.com/) | [Link](docs/configuring-playbook-bridge-mautrix-gmessages.md) |
|
||||
| [mautrix-gvoice](https://github.com/mautrix/gvoice) | ❌ | Bridge to [Google Voice](https://voice.google.com/) | [Link](docs/configuring-playbook-bridge-mautrix-gvoice.md) |
|
||||
| [mautrix-whatsapp](https://github.com/mautrix/whatsapp) | ❌ | Bridge to [WhatsApp](https://www.whatsapp.com/) | [Link](docs/configuring-playbook-bridge-mautrix-whatsapp.md) |
|
||||
| [mautrix-wsproxy](https://github.com/mautrix/wsproxy) | ❌ | Bridge to Android SMS or Apple iMessage | [Link](docs/configuring-playbook-bridge-mautrix-wsproxy.md) |
|
||||
| [matrix-rustpush-bridge](https://github.com/jasonlaguidice/imessage) | ❌ | Bridge to [iMessage](https://support.apple.com/messages) via Apple Push Notification service | [Link](docs/configuring-playbook-bridge-rustpush.md) |
|
||||
| [mautrix-bluesky](https://github.com/mautrix/bluesky) | ❌ | Bridge to [Bluesky](https://bsky.social/) | [Link](docs/configuring-playbook-bridge-mautrix-bluesky.md) |
|
||||
| [mautrix-twitter](https://github.com/mautrix/twitter) | ❌ | Bridge to [Twitter](https://twitter.com/) | [Link](docs/configuring-playbook-bridge-mautrix-twitter.md) |
|
||||
| [mautrix-googlechat](https://github.com/mautrix/googlechat) | ❌ | Bridge to [Google Chat](https://en.wikipedia.org/wiki/Google_Chat) | [Link](docs/configuring-playbook-bridge-mautrix-googlechat.md) |
|
||||
@@ -124,7 +127,6 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
| [mautrix-signal](https://github.com/mautrix/signal) | ❌ | Bridge to [Signal](https://www.signal.org/) | [Link](docs/configuring-playbook-bridge-mautrix-signal.md) |
|
||||
| [beeper-linkedin](https://github.com/beeper/linkedin) | ❌ | Bridge to [LinkedIn](https://www.linkedin.com/) | [Link](docs/configuring-playbook-bridge-beeper-linkedin.md) |
|
||||
| [matrix-appservice-irc](https://github.com/matrix-org/matrix-appservice-irc) | ❌ | Bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat) | [Link](docs/configuring-playbook-bridge-appservice-irc.md) |
|
||||
| [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) | ❌ | Bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) | [Link](docs/configuring-playbook-bridge-appservice-kakaotalk.md) |
|
||||
| [matrix-appservice-discord](https://github.com/matrix-org/matrix-appservice-discord) | ❌ | Bridge to [Discord](https://discordapp.com/) | [Link](docs/configuring-playbook-bridge-appservice-discord.md) |
|
||||
| [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) | ❌ | Bridge for generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular | [Link](docs/configuring-playbook-bridge-hookshot.md) |
|
||||
| [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) | ❌ | Bridge to SMS | [Link](docs/configuring-playbook-bridge-matrix-bridge-sms.md) |
|
||||
@@ -144,7 +146,6 @@ Bots provide various additional functionality to your installation.
|
||||
| ---- | -------- | ----------- | ------------- |
|
||||
| [baibot](https://github.com/etkecc/baibot) | ❌ | Bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you | [Link](docs/configuring-playbook-bot-baibot.md) |
|
||||
| [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) | ❌ | Bot for scheduling one-off & recurring reminders and alarms | [Link](docs/configuring-playbook-bot-matrix-reminder-bot.md) |
|
||||
| [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) | ❌ | Bot for invitations by creating and managing registration tokens | [Link](docs/configuring-playbook-bot-matrix-registration-bot.md) |
|
||||
| [maubot](https://github.com/maubot/maubot) | ❌ | Plugin-based Matrix bot system | [Link](docs/configuring-playbook-bot-maubot.md) |
|
||||
| [Honoroit](https://github.com/etkecc/honoroit) | ❌ | Helpdesk bot | [Link](docs/configuring-playbook-bot-honoroit.md) |
|
||||
| [Mjolnir](https://github.com/matrix-org/mjolnir) | ❌ | Moderation tool for Matrix | [Link](docs/configuring-playbook-bot-mjolnir.md) |
|
||||
|
||||
Executable
+120
@@ -0,0 +1,120 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# SPDX-FileCopyrightText: 2026 MDAD project contributors
|
||||
# SPDX-FileCopyrightText: 2026 Slavi Pantaleev
|
||||
#
|
||||
# SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Adds a new host to the inventory, based on the example files in `examples/`:
|
||||
# - creates `inventory/hosts` (or adds the host to it, if it already exists)
|
||||
# - creates `inventory/host_vars/matrix.DOMAIN/vars.yml` with strong secrets generated automatically
|
||||
#
|
||||
# Existing configuration for the same host is never overwritten - the script refuses to run instead.
|
||||
#
|
||||
# Usage: bin/add-inventory-host.sh <base-domain> <server-address>
|
||||
#
|
||||
# - <base-domain> is the base domain (`example.com`), not the Matrix server hostname (`matrix.example.com`)
|
||||
# - <server-address> is the server's external IP address or domain name
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
base_path="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
|
||||
|
||||
if [ $# -ne 2 ]; then
|
||||
echo "Usage: $0 <base-domain> <server-address>" >&2
|
||||
echo "Example: $0 example.com 1.2.3.4" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
domain="$1"
|
||||
server_address="$2"
|
||||
|
||||
if ! printf '%s' "${domain}" | grep -Eq '^[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?(\.[a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?)+$'; then
|
||||
echo "Error: '${domain}' does not look like a valid domain name" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if ! printf '%s' "${server_address}" | grep -Eq '^[A-Za-z0-9.:_-]+$'; then
|
||||
echo "Error: '${server_address}' does not look like a valid server address (IP address or domain name)" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
case "${domain}" in
|
||||
matrix.*)
|
||||
echo "Warning: you likely need to pass your base domain (example.com), not the Matrix server hostname (matrix.example.com)." >&2
|
||||
echo "Proceeding anyway. Your Matrix server hostname will be: matrix.${domain}" >&2
|
||||
;;
|
||||
esac
|
||||
|
||||
matrix_hostname="matrix.${domain}"
|
||||
hosts_file="${base_path}/inventory/hosts"
|
||||
vars_dir="${base_path}/inventory/host_vars/${matrix_hostname}"
|
||||
vars_file="${vars_dir}/vars.yml"
|
||||
hosts_entry="${matrix_hostname} ansible_host=${server_address} ansible_ssh_user=root"
|
||||
|
||||
if [ -e "${vars_dir}" ]; then
|
||||
echo "Error: ${vars_dir} already exists. Refusing to overwrite it." >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ -f "${hosts_file}" ]; then
|
||||
if ! grep -q '^\[matrix_servers\]' "${hosts_file}"; then
|
||||
echo "Error: ${hosts_file} exists, but does not contain a [matrix_servers] section." >&2
|
||||
echo "Unrecognized inventory format. Add the host to it manually:" >&2
|
||||
echo "${hosts_entry}" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
matrix_hostname_pattern="$(printf '%s' "${matrix_hostname}" | sed 's|\.|\\.|g')"
|
||||
if grep -Eq "^${matrix_hostname_pattern}([[:space:]]|$)" "${hosts_file}"; then
|
||||
echo "Error: ${hosts_file} already contains an entry for ${matrix_hostname}. Refusing to modify it." >&2
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
generate_secret() {
|
||||
if command -v pwgen >/dev/null 2>&1; then
|
||||
pwgen -s 64 1
|
||||
elif command -v openssl >/dev/null 2>&1; then
|
||||
openssl rand -base64 192 | LC_ALL=C tr -dc 'A-Za-z0-9' | head -c 64
|
||||
else
|
||||
head -c 4096 /dev/urandom | LC_ALL=C tr -dc 'A-Za-z0-9' | head -c 64
|
||||
fi
|
||||
}
|
||||
|
||||
generic_secret_key="$(generate_secret)"
|
||||
postgres_password="$(generate_secret)"
|
||||
|
||||
for secret in "${generic_secret_key}" "${postgres_password}"; do
|
||||
if [ "${#secret}" -lt 64 ]; then
|
||||
echo "Error: failed to generate a secret" >&2
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
mkdir -p "${vars_dir}"
|
||||
|
||||
sed \
|
||||
-e "s|^matrix_domain:.*|matrix_domain: ${domain}|" \
|
||||
-e "s|^matrix_homeserver_generic_secret_key:.*|matrix_homeserver_generic_secret_key: '${generic_secret_key}'|" \
|
||||
-e "s|^postgres_connection_password:.*|postgres_connection_password: '${postgres_password}'|" \
|
||||
"${base_path}/examples/vars.yml" > "${vars_file}"
|
||||
|
||||
if [ -f "${hosts_file}" ]; then
|
||||
# Insert the new host right after the [matrix_servers] section header.
|
||||
hosts_file_tmp="$(mktemp "${hosts_file}.XXXXXX")"
|
||||
awk -v entry="${hosts_entry}" '{print} $0 ~ /^\[matrix_servers\]/ && !done {print entry; done=1}' \
|
||||
"${hosts_file}" > "${hosts_file_tmp}"
|
||||
mv "${hosts_file_tmp}" "${hosts_file}"
|
||||
else
|
||||
sed \
|
||||
-e "s|^matrix\.example\.com .*|${hosts_entry}|" \
|
||||
"${base_path}/examples/hosts" > "${hosts_file}"
|
||||
fi
|
||||
|
||||
echo "Added host ${matrix_hostname} to the inventory:"
|
||||
echo "- ${hosts_file}"
|
||||
echo "- ${vars_file}"
|
||||
echo ""
|
||||
echo "Secrets were generated automatically for matrix_homeserver_generic_secret_key and postgres_connection_password."
|
||||
echo "Review and adjust these files before installing."
|
||||
@@ -30,12 +30,12 @@ fi
|
||||
cp -ar $messenger_role_path $instagram_role_path
|
||||
|
||||
find "$instagram_role_path" -type f | while read -r file; do
|
||||
sed --in-place 's/matrix_mautrix_meta_messenger_/matrix_mautrix_meta_instagram_/g' "$file"
|
||||
sed --in-place 's/matrix_bridge_mautrix_meta_messenger_/matrix_bridge_mautrix_meta_instagram_/g' "$file"
|
||||
sed --in-place 's/mautrix-meta-messenger/mautrix-meta-instagram/g' "$file"
|
||||
done
|
||||
|
||||
sed --in-place 's/matrix_mautrix_meta_instagram_meta_mode: \(.*\)/matrix_mautrix_meta_instagram_meta_mode: instagram/g' $instagram_role_path/defaults/main.yml
|
||||
sed --in-place 's/matrix_mautrix_meta_instagram_identifier: \(.*\)/matrix_mautrix_meta_instagram_identifier: matrix-mautrix-meta-instagram/g' $instagram_role_path/defaults/main.yml
|
||||
sed --in-place 's/matrix_bridge_mautrix_meta_instagram_meta_mode: \(.*\)/matrix_bridge_mautrix_meta_instagram_meta_mode: instagram/g' $instagram_role_path/defaults/main.yml
|
||||
sed --in-place 's/matrix_bridge_mautrix_meta_instagram_identifier: \(.*\)/matrix_bridge_mautrix_meta_instagram_identifier: matrix-mautrix-meta-instagram/g' $instagram_role_path/defaults/main.yml
|
||||
|
||||
# Create the README.md file with the license header
|
||||
cat > $instagram_role_path/README.md << 'EOF'
|
||||
|
||||
@@ -76,6 +76,8 @@ If your server and services experience issues, feel free to come to [our support
|
||||
|
||||
- [Alternative architectures](alternative-architectures.md)
|
||||
|
||||
- [Configuring Synology DSM](configuring-playbook-synology.md)
|
||||
|
||||
- [Container images used by the playbook](container-images.md)
|
||||
|
||||
- [Obtaining an Access Token](obtaining-access-tokens.md)
|
||||
|
||||
@@ -50,6 +50,8 @@ This ensures that:
|
||||
|
||||
You can either [run Ansible in a container on the Matrix server itself](#running-ansible-in-a-container-on-the-matrix-server-itself) or [run Ansible in a container on another computer (not the Matrix server)](#running-ansible-in-a-container-on-another-computer-not-the-matrix-server).
|
||||
|
||||
💡 If you use [Visual Studio Code](https://code.visualstudio.com/) or [GitHub Codespaces](https://github.com/features/codespaces), the playbook also ships a [dev container](https://containers.dev/) configuration (see the `.devcontainer/` directory) based on this same Ansible Docker image, which can prepare such a containerized Ansible environment for you automatically.
|
||||
|
||||
### Running Ansible in a container on the Matrix server itself
|
||||
|
||||
To run Ansible in a (Docker) container on the Matrix server itself, you need to have a working Docker installation. Docker is normally installed by the playbook, so this may be a bit of a chicken and egg problem. To solve it:
|
||||
|
||||
@@ -15,6 +15,8 @@ Captcha can be enabled for this home server. This file explains how to do that.
|
||||
|
||||
The captcha mechanism used is Google's [ReCaptcha](https://www.google.com/recaptcha/). This requires API keys from Google. If your homeserver is Dendrite then [hCapcha](https://www.hcaptcha.com) can be used instead.
|
||||
|
||||
If you are using [Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md), captcha is configured there instead (it handles registration), and [Cloudflare Turnstile](https://www.cloudflare.com/application-services/products/turnstile/) is supported as well. See [Matrix Authentication Service](#matrix-authentication-service) below.
|
||||
|
||||
## ReCaptcha
|
||||
|
||||
### Getting keys
|
||||
@@ -61,3 +63,16 @@ matrix_dendrite_client_api_recaptcha_api_js_url: 'https://js.hcaptcha.com/1/api.
|
||||
matrix_dendrite_client_api_recaptcha_form_field: 'h-captcha-response'
|
||||
matrix_dendrite_client_api_recaptcha_sitekey_class: 'h-captcha'
|
||||
```
|
||||
|
||||
## Matrix Authentication Service
|
||||
|
||||
When [Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) is enabled, registration and other account operations are handled by it, so captcha protection is configured there (the Synapse and Dendrite settings above do not apply).
|
||||
|
||||
Matrix Authentication Service supports [ReCaptcha v2](http://www.google.com/recaptcha/admin), [Cloudflare Turnstile](https://www.cloudflare.com/application-services/products/turnstile/) and [hCaptcha](https://dashboard.hcaptcha.com/sites/new). Obtain a site/secret key pair from your chosen service, then add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
# Valid values: recaptcha_v2, cloudflare_turnstile, hcaptcha
|
||||
matrix_authentication_service_config_captcha_service: recaptcha_v2
|
||||
matrix_authentication_service_config_captcha_site_key: 'YOUR_SITE_KEY'
|
||||
matrix_authentication_service_config_captcha_secret_key: 'YOUR_SECRET_KEY'
|
||||
```
|
||||
|
||||
@@ -14,7 +14,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
🤖 [baibot](https://github.com/etkecc/baibot) (pronounced bye-bot) is a [Matrix](https://matrix.org/) bot developed by [etke.cc](https://etke.cc/) that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you. 🤖
|
||||
|
||||
It supports [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) models, as many well as other [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md).
|
||||
It supports many [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md), including the privacy-first [Venice](#venice) we recommend, [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) models, and more.
|
||||
|
||||
It's designed as a more private and [✨ featureful](https://github.com/etkecc/baibot/?tab=readme-ov-file#-features) alternative to [matrix-chatgpt-bot](./configuring-playbook-bot-chatgpt.md). See the [baibot](https://github.com/etkecc/baibot) project and its documentation for more information.
|
||||
|
||||
@@ -159,7 +159,38 @@ Agents defined statically and those created dynamically (via chat) are named dif
|
||||
|
||||
Depending on your propensity for [GitOps](https://en.wikipedia.org/wiki/DevOps#GitOps), you may prefer to define agents statically via Ansible, or you may wish to do it dynamically via chat.
|
||||
|
||||
Before proceeding, we recommend reading the upstream documentation on [How to choose a provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#how-to-choose-a-provider). In short, it's probably best to go with [OpenAI](#openai).
|
||||
Before proceeding, we recommend reading the upstream documentation on [How to choose a provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#how-to-choose-a-provider) for a side-by-side of what each one can do. In short: we recommend [Venice](#venice), the most capable provider baibot supports and the only one that keeps no logs and trains on nothing. If you'd rather start with the most widely-used option, [OpenAI](#openai) is a solid, well-supported choice too.
|
||||
|
||||
#### Venice
|
||||
|
||||
[Venice](https://venice.ai/chat?ref=kpXDe6) _(ref link with a $10 bonus for you)_ is the provider we recommend. It's the most capable one baibot supports, and the only one that pairs that full feature set with real privacy: inference runs on Venice's own GPUs or on zero-data-retention partner hardware, so your prompts and replies are stored nowhere and never used for training. It serves both frontier proprietary models and the latest open-source ones.
|
||||
|
||||
Venice also leaves the content policy to you instead of imposing its own. Its models answer without the reflexive refusals some hosted services apply, and both text and image generation can handle adult or otherwise sensitive subjects when you need them to. Image generation ships a `safe_mode` that blurs adult content by default; you can turn it off (see the sample config). This pairs naturally with the privacy above: a bot you can speak to candidly, that keeps nothing.
|
||||
|
||||
Unlike the [OpenAI Compatible](#openai-compatible) provider (which can also point at Venice, but drops images and can't reach its audio or native image endpoints), this is a first-class integration that exposes Venice's full parameter set: text-generation with vision, file inputs, prompt caching and native web search, plus speech-to-text, text-to-speech, and image generation and editing.
|
||||
|
||||
You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Venice provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#venice) with the help of the playbook's preset variables.
|
||||
|
||||
Here's an example **addition** to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_bot_baibot_config_agents_static_definitions_venice_enabled: true
|
||||
|
||||
matrix_bot_baibot_config_agents_static_definitions_venice_config_api_key: "YOUR_API_KEY_HERE"
|
||||
|
||||
# The preset ships sensible defaults for every purpose, so changing only the API key above is enough
|
||||
# to get going. Uncomment and adjust any of these if you'd like to use different models:
|
||||
# matrix_bot_baibot_config_agents_static_definitions_venice_config_text_generation_model_id: kimi-k2-5
|
||||
# matrix_bot_baibot_config_agents_static_definitions_venice_config_image_generation_model_id: chroma
|
||||
```
|
||||
|
||||
Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/venice`.
|
||||
|
||||
Every Venice knob (sampling, caching, reasoning, web-search behavior, voice and image controls) has a matching `matrix_bot_baibot_config_agents_static_definitions_venice_config_*` variable. The [fully-commented sample config](https://github.com/etkecc/baibot/blob/main/docs/sample-provider-configs/venice.yml) explains every one of them.
|
||||
|
||||
If you'd like to use more than one model, take a look at the [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset) section below.
|
||||
|
||||
💡 You may also wish to use this new agent for [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers).
|
||||
|
||||
#### Anthropic
|
||||
|
||||
@@ -374,7 +405,7 @@ Example **additional** `vars.yml` configuration:
|
||||
# As such, changing any of these values subsequently has no effect on the bot's behavior.
|
||||
# Once initially configured, the global configuration is managed via bot commands, not via Ansible.
|
||||
|
||||
matrix_bot_baibot_config_initial_global_config_handler_catch_all: static/openai
|
||||
matrix_bot_baibot_config_initial_global_config_handler_catch_all: static/venice
|
||||
|
||||
# In this example, there's no need to define any of these below.
|
||||
# Configuring the catch-all purpose handler is enough.
|
||||
|
||||
@@ -1,103 +1,34 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2022 - 2023 Julian-Samuel Gebühr
|
||||
SPDX-FileCopyrightText: 2022 - 2024 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2019 Edgars Voroboks
|
||||
SPDX-FileCopyrightText: 2019 Eduardo Beltrame
|
||||
SPDX-FileCopyrightText: 2019-2025 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2019-2025 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2020 Chris van Dijk
|
||||
SPDX-FileCopyrightText: 2020 Tulir Asokan
|
||||
SPDX-FileCopyrightText: 2020 jens quade
|
||||
SPDX-FileCopyrightText: 2022 Dennis Ciba
|
||||
SPDX-FileCopyrightText: 2022 Erick Wibben
|
||||
SPDX-FileCopyrightText: 2022 Kim Brose
|
||||
SPDX-FileCopyrightText: 2022 Kolja Lampe
|
||||
SPDX-FileCopyrightText: 2023 - 2024 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
SPDX-FileCopyrightText: 2022 Travis Ralston
|
||||
SPDX-FileCopyrightText: 2022 Vladimir Panteleev
|
||||
SPDX-FileCopyrightText: 2022 Yan Minagawa
|
||||
SPDX-FileCopyrightText: 2022, 2023 Julian-Samuel Gebühr
|
||||
SPDX-FileCopyrightText: 2024-2026 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up matrix-registration-bot (optional)
|
||||
# Setting up matrix-registration-bot (optional, removed)
|
||||
|
||||
The playbook can install and configure [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) for you.
|
||||
🪦 The playbook used to be able to install and configure [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot), but no longer includes this component, as it has been unmaintained.
|
||||
|
||||
The bot allows you to easily **create and manage registration tokens** aka. invitation codes. It can be used for an invitation-based server, where you invite someone by sending them a registration token (tokens look like this: `rbalQ0zkaDSRQCOp`). They can register as per normal but have to provide a valid registration token in the final step of the registration process.
|
||||
## Uninstalling the component manually
|
||||
|
||||
See the project's [documentation](https://github.com/moan0s/matrix-registration-bot/blob/master/README.md) to learn what it does and why it might be useful to you.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_bot_matrix_registration_bot_enabled: true
|
||||
|
||||
# By default, the playbook will set use the bot with a username like this: `@bot.matrix-registration-bot:example.com`.
|
||||
# Uncomment and adjust this part if you'd like to use a username different than the default
|
||||
# matrix_bot_matrix_registration_bot_matrix_user_id_localpart: bot.matrix-registration-bot
|
||||
|
||||
# Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`.
|
||||
matrix_bot_matrix_registration_bot_bot_password: PASSWORD_FOR_THE_BOT
|
||||
|
||||
# Enables registration
|
||||
matrix_synapse_enable_registration: true
|
||||
|
||||
# Restrict registration to users with a token
|
||||
matrix_synapse_registration_requires_token: true
|
||||
|
||||
# Set an optional command prefix for the bot. This can be any arbitrary string, including whitespace.
|
||||
# Example: "!regbot "
|
||||
matrix_bot_matrix_registration_bot_bot_prefix: ""
|
||||
```
|
||||
|
||||
The bot account will be created automatically.
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the bot.
|
||||
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bot-matrix-registration-bot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
- `roles/custom/matrix-bot-matrix-registration-bot/templates/config.yaml.j2` for the bridge's default configuration
|
||||
|
||||
## Installing
|
||||
|
||||
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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed.
|
||||
|
||||
- If you change the bot password (`matrix_bot_matrix_registration_bot_bot_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [Ketesa](configuring-playbook-ketesa.md) to change it, and then update `matrix_bot_matrix_registration_bot_bot_password` to let the bot know its new password.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bot, start a chat with `@bot.matrix-registration-bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
Send `help` to the bot to see the available commands.
|
||||
|
||||
You can also refer to the upstream [Usage documentation](https://github.com/moan0s/matrix-registration-bot#supported-commands).
|
||||
|
||||
If you have any questions, or if you need help setting it up, read the [troubleshooting guide](https://github.com/moan0s/matrix-registration-bot/blob/main/docs/troubleshooting.md) or join [#matrix-registration-bot:hyteck.de](https://matrix.to/#/#matrix-registration-bot:hyteck.de).
|
||||
|
||||
To clean the cache (session & encryption data) after you changed the bot's username, changed the login method from access_token to password etc… you can use:
|
||||
If you still have matrix-registration-bot installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:
|
||||
|
||||
```sh
|
||||
just run-tags bot-matrix-registration-bot-clean-cache
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-matrix-registration-bot`.
|
||||
|
||||
### Increase logging verbosity
|
||||
|
||||
The default logging level for this component is `INFO`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
# Valid values: ERROR, INFO, DEBUG
|
||||
matrix_bot_matrix_registration_bot_logging_level: DEBUG
|
||||
systemctl disable --now matrix-bot-matrix-registration-bot.service
|
||||
|
||||
rm -rf /matrix/matrix-registration-bot
|
||||
```
|
||||
|
||||
@@ -26,9 +26,9 @@ Create a Discord Application [here](https://discordapp.com/developers/applicatio
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_appservice_discord_enabled: true
|
||||
matrix_appservice_discord_client_id: "YOUR DISCORD APP CLIENT ID"
|
||||
matrix_appservice_discord_bot_token: "YOUR DISCORD APP BOT TOKEN"
|
||||
matrix_bridge_appservice_discord_enabled: true
|
||||
matrix_bridge_appservice_discord_client_id: "YOUR DISCORD APP CLIENT ID"
|
||||
matrix_bridge_appservice_discord_bot_token: "YOUR DISCORD APP BOT TOKEN"
|
||||
|
||||
# As of Synapse 1.90.0, uncomment to enable the backwards compatibility (https://matrix-org.github.io/synapse/latest/upgrade#upgrading-to-v1900) that this bridge needs.
|
||||
# Note: This deprecated method is considered insecure.
|
||||
@@ -44,7 +44,7 @@ There are some additional things you may wish to configure about the bridge.
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bridge-appservice-discord/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
- `roles/custom/matrix-bridge-appservice-discord/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_discord_configuration_extension_yaml` variable
|
||||
- `roles/custom/matrix-bridge-appservice-discord/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_appservice_discord_configuration_extension_yaml` variable
|
||||
|
||||
## Installing
|
||||
|
||||
@@ -65,7 +65,7 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju
|
||||
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 `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_appservice_discord_bridge_enableSelfServiceBridging: true
|
||||
matrix_bridge_appservice_discord_bridge_enableSelfServiceBridging: true
|
||||
```
|
||||
|
||||
**Note**: If self-service bridging is not enabled, `!discord help` commands will return no results.
|
||||
@@ -91,14 +91,14 @@ All Matrix rooms created this way are **listed publicly** by default, and you wi
|
||||
To disable portal bridging, add the following configuration to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_appservice_discord_bridge_disablePortalBridging: true
|
||||
matrix_bridge_appservice_discord_bridge_disablePortalBridging: true
|
||||
```
|
||||
|
||||
### Usage
|
||||
|
||||
To get started with Portal Bridging:
|
||||
|
||||
1. To invite the bot to Discord, retrieve the invite link from the `{{ matrix_appservice_discord_config_path }}/invite_link` file on the server (this defaults to `/matrix/appservice-discord/config/invite_link`). You need to peek at the file on the server via SSH, etc., because it's not available via HTTP(S).
|
||||
1. To invite the bot to Discord, retrieve the invite link from the `{{ matrix_bridge_appservice_discord_config_path }}/invite_link` file on the server (this defaults to `/matrix/appservice-discord/config/invite_link`). You need to peek at the file on the server via SSH, etc., because it's not available via HTTP(S).
|
||||
2. Room addresses follow this syntax: `#_discord_<guildID>_<channelID>`. You can easily find the guild and channel IDs by logging into Discord in a browser and opening the desired channel. The URL will have this format: `discord.com/channels/<guildID>/<channelID>`.
|
||||
3. Once you have figured out the appropriate room address, you can join by doing `/join #_discord_<guildID>_<channelID>` in your Matrix client.
|
||||
|
||||
@@ -124,7 +124,7 @@ As with all other services, you can find the logs in [systemd-journald](https://
|
||||
The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file (adapt to your needs) and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
matrix_appservice_discord_configuration_extension_yaml: |
|
||||
matrix_bridge_appservice_discord_configuration_extension_yaml: |
|
||||
logging:
|
||||
# What level should the logger output to the console at.
|
||||
console: "info" # Valid values: silent, error, warn, http, info, verbose, silly
|
||||
|
||||
@@ -20,9 +20,9 @@ See the project's [documentation](https://github.com/matrix-org/matrix-appservic
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_appservice_irc_enabled: true
|
||||
matrix_bridge_appservice_irc_enabled: true
|
||||
|
||||
matrix_appservice_irc_ircService_servers:
|
||||
matrix_bridge_appservice_irc_ircService_servers:
|
||||
irc.example.com:
|
||||
name: "ExampleNet"
|
||||
port: 6697
|
||||
@@ -76,7 +76,7 @@ There are some additional things you may wish to configure about the bridge.
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bridge-appservice-irc/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
- `roles/custom/matrix-bridge-appservice-irc/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_irc_configuration_extension_yaml` variable
|
||||
- `roles/custom/matrix-bridge-appservice-irc/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_appservice_irc_configuration_extension_yaml` variable
|
||||
|
||||
## Installing
|
||||
|
||||
@@ -104,7 +104,7 @@ As with all other services, you can find the logs in [systemd-journald](https://
|
||||
The default logging level for this component is `debug`, and the log is output to the console only. If you want to change the verbosity or enable logging to a file, add the following configuration to your `vars.yml` file (adapt to your needs) and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
matrix_appservice_irc_configuration_extension_yaml: |
|
||||
matrix_bridge_appservice_irc_configuration_extension_yaml: |
|
||||
logging:
|
||||
# Level to log on console/logfile.
|
||||
# Valid values: error, warn, info, debug
|
||||
|
||||
@@ -1,75 +1,26 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2022 Dennis Ciba
|
||||
SPDX-FileCopyrightText: 2022 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2022 - 2026 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
SPDX-FileCopyrightText: 2024 MDAD project contributors
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up Appservice Kakaotalk bridging (optional)
|
||||
# Setting up Appservice Kakaotalk bridging (optional, removed)
|
||||
|
||||
The playbook can install and configure [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) for you, for bridging to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG). This bridge is based on [node-kakao](https://github.com/storycraft/node-kakao) (now unmaintained) and some [mautrix-facebook](https://github.com/mautrix/facebook) code.
|
||||
🪦 The playbook used to be able to install and configure [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) (a bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG)), but no longer includes this component.
|
||||
|
||||
See the project's [documentation](https://src.miscworks.net/fair/matrix-appservice-kakaotalk/src/branch/master/README.md) to learn what it does and why it might be useful to you.
|
||||
The bridge could only be installed by self-building its source code, and its upstream repository has become unreachable, which makes installation impossible. The bridge was also based on the now-unmaintained [node-kakao](https://github.com/storycraft/node-kakao) library, and there have been reports that using it may get your Kakaotalk account banned.
|
||||
|
||||
> [!WARNING]
|
||||
> There have been recent reports (~2022-09-16) that **using this bridge may get your account banned**.
|
||||
## Uninstalling the component manually
|
||||
|
||||
## Prerequisite (optional)
|
||||
If you still have matrix-appservice-kakaotalk installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:
|
||||
|
||||
### Enable Shared Secret Auth
|
||||
|
||||
If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook.
|
||||
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting.
|
||||
|
||||
**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_appservice_kakaotalk_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the bridge.
|
||||
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bridge-appservice-kakaotalk/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
- `roles/custom/matrix-bridge-appservice-kakaotalk/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_kakaotalk_configuration_extension_yaml` variable
|
||||
|
||||
## Installing
|
||||
|
||||
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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to start a chat with `@kakaotalkbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
You then need to send `login --save EMAIL_OR_PHONE_NUMBER` to the bridge bot to enable bridging for your Kakaotalk account. The `--save` flag may be omitted, if you'd rather not save your password.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-appservice-kakaotalk`.
|
||||
|
||||
### Increase logging verbosity
|
||||
|
||||
The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
matrix_appservice_kakaotalk_logging_level: DEBUG
|
||||
systemctl disable --now matrix-appservice-kakaotalk.service
|
||||
|
||||
systemctl disable --now matrix-appservice-kakaotalk-node.service
|
||||
|
||||
rm -rf /matrix/appservice-kakaotalk
|
||||
```
|
||||
|
||||
@@ -29,7 +29,7 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_beeper_linkedin_enabled: true
|
||||
matrix_bridge_beeper_linkedin_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
@@ -68,7 +68,7 @@ As with all other services, you can find the logs in [systemd-journald](https://
|
||||
The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
matrix_beeper_linkedin_logging_level: DEBUG
|
||||
matrix_bridge_beeper_linkedin_logging_level: DEBUG
|
||||
```
|
||||
|
||||
### Bridge asking for 2FA even if you don't have 2FA enabled
|
||||
|
||||
@@ -25,26 +25,26 @@ If you wish to adjust it, see the section [below](#adjusting-the-heisenbridge-ur
|
||||
To enable Heisenbridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_heisenbridge_enabled: true
|
||||
matrix_bridge_heisenbridge_enabled: true
|
||||
|
||||
# Setting the owner is optional as the first local user to DM `@heisenbridge:example.com` will be made the owner.
|
||||
# If you are not using a local user you must set it as otherwise you can't DM it at all.
|
||||
matrix_heisenbridge_owner: "@alice:{{ matrix_domain }}"
|
||||
matrix_bridge_heisenbridge_owner: "@alice:{{ matrix_domain }}"
|
||||
|
||||
# Uncomment to enable identd on host port 113/TCP (optional)
|
||||
# matrix_heisenbridge_identd_enabled: true
|
||||
# matrix_bridge_heisenbridge_identd_enabled: true
|
||||
```
|
||||
|
||||
### Adjusting the Heisenbridge URL (optional)
|
||||
|
||||
By tweaking the `matrix_heisenbridge_hostname` and `matrix_heisenbridge_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one.
|
||||
By tweaking the `matrix_bridge_heisenbridge_hostname` and `matrix_bridge_heisenbridge_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one.
|
||||
|
||||
Example additional configuration for your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
# Change the default hostname and path prefix
|
||||
matrix_heisenbridge_hostname: heisenbridge.example.com
|
||||
matrix_heisenbridge_path_prefix: /
|
||||
matrix_bridge_heisenbridge_hostname: heisenbridge.example.com
|
||||
matrix_bridge_heisenbridge_path_prefix: /
|
||||
```
|
||||
|
||||
If you've changed the default hostname, you may need to create a CNAME record for the Heisenbridge domain (`heisenbridge.example.com`), which targets `matrix.example.com`.
|
||||
|
||||
@@ -29,20 +29,30 @@ You need to download the private key file, if you will install the file manually
|
||||
Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `GITHUB_PRIVATE_KEY_HERE` with the one created [above](#download-github-app-private-key).
|
||||
|
||||
```yaml
|
||||
matrix_hookshot_enabled: true
|
||||
matrix_bridge_hookshot_enabled: true
|
||||
|
||||
# Uncomment to enable end-to-bridge encryption.
|
||||
# See: https://matrix-org.github.io/matrix-hookshot/latest/advanced/encryption.html
|
||||
# matrix_hookshot_encryption_enabled: true
|
||||
# matrix_bridge_hookshot_encryption_enabled: true
|
||||
|
||||
# Uncomment and paste the contents of GitHub app private key to enable GitHub bridge.
|
||||
# Alternatively, you can use one of the other methods explained below on the "Manage GitHub Private Key with aux role" section.
|
||||
# matrix_hookshot_github_private_key: "GITHUB_PRIVATE_KEY_HERE"
|
||||
# matrix_bridge_hookshot_github_private_key: "GITHUB_PRIVATE_KEY_HERE"
|
||||
```
|
||||
|
||||
For each of the services (GitHub, GitLab, Jira, Figma, and generic webhooks) fill in the respective variables `matrix_hookshot_service_*` listed in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) as required.
|
||||
> [!NOTE]
|
||||
> End-to-bridge encryption also requires the homeserver to support (and have enabled) [MSC2409](https://github.com/matrix-org/matrix-spec-proposals/pull/2409) and [MSC3202](https://github.com/matrix-org/matrix-spec-proposals/pull/3202). If you are using Synapse, enable them by also adding this to your `vars.yml` file:
|
||||
>
|
||||
> ```yaml
|
||||
> matrix_synapse_experimental_features_msc2409_to_device_messages_enabled: true
|
||||
> matrix_synapse_experimental_features_msc3202_transaction_extensions_enabled: true
|
||||
> ```
|
||||
>
|
||||
> These are experimental homeserver-wide features (as is Hookshot's encryption support itself), so enable them deliberately.
|
||||
|
||||
Take special note of the `matrix_hookshot_*_enabled` variables. Services that need no further configuration are enabled by default (GitLab and generic webhooks), while you must first add the required configuration and enable the others (GitHub, Jira, and Figma).
|
||||
For each of the services (GitHub, GitLab, Jira, Figma, and generic webhooks) fill in the respective variables `matrix_bridge_hookshot_service_*` listed in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) as required.
|
||||
|
||||
Take special note of the `matrix_bridge_hookshot_*_enabled` variables. Services that need no further configuration are enabled by default (GitLab and generic webhooks), while you must first add the required configuration and enable the others (GitHub, Jira, and Figma).
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
@@ -51,7 +61,7 @@ There are some additional things you may wish to configure about the bridge.
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bridge-hookshot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
- `roles/custom/matrix-bridge-hookshot/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_hookshot_configuration_extension_yaml` and `matrix_hookshot_registration_extension_yaml` variables
|
||||
- `roles/custom/matrix-bridge-hookshot/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_hookshot_configuration_extension_yaml` and `matrix_bridge_hookshot_registration_extension_yaml` variables
|
||||
|
||||
Refer the [official instructions](https://matrix-org.github.io/matrix-hookshot/latest/setup.html) and the comments in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) to learn what the individual options do.
|
||||
|
||||
@@ -96,31 +106,31 @@ Unless indicated otherwise, the following endpoints are reachable on your `matri
|
||||
|
||||
| Listener | Default path | Variable | Used as |
|
||||
|---|---|---|---|
|
||||
| - | `/hookshot/webhooks/` | `matrix_hookshot_webhook_endpoint` | Webhook-prefix, which affects all webhook-related URLs below |
|
||||
| generic | `/hookshot/webhooks/webhook` | `matrix_hookshot_generic_endpoint` | Generic webhooks |
|
||||
| github oauth | `/hookshot/webhooks/oauth` | `matrix_hookshot_github_oauth_endpoint` | GitHub "Callback URL" |
|
||||
| jira oauth | `/hookshot/webhooks/jira/oauth` | `matrix_hookshot_jira_oauth_endpoint` | Jira OAuth |
|
||||
| figma endpoint | `/hookshot/webhooks/figma/webhook` | `matrix_hookshot_figma_endpoint` | Figma |
|
||||
| appservice | `/hookshot/_matrix/app/` | `matrix_hookshot_appservice_endpoint` | Matrix server |
|
||||
| widgets | `/hookshot/widgetapi/` | `matrix_hookshot_widgets_endpoint` | Widgets |
|
||||
| - | `/hookshot/webhooks/` | `matrix_bridge_hookshot_webhook_endpoint` | Webhook-prefix, which affects all webhook-related URLs below |
|
||||
| generic | `/hookshot/webhooks/webhook` | `matrix_bridge_hookshot_generic_endpoint` | Generic webhooks |
|
||||
| github oauth | `/hookshot/webhooks/oauth` | `matrix_bridge_hookshot_github_oauth_endpoint` | GitHub "Callback URL" |
|
||||
| jira oauth | `/hookshot/webhooks/jira/oauth` | `matrix_bridge_hookshot_jira_oauth_endpoint` | Jira OAuth |
|
||||
| figma endpoint | `/hookshot/webhooks/figma/webhook` | `matrix_bridge_hookshot_figma_endpoint` | Figma |
|
||||
| appservice | `/hookshot/_matrix/app/` | `matrix_bridge_hookshot_appservice_endpoint` | Matrix server |
|
||||
| widgets | `/hookshot/widgetapi/` | `matrix_bridge_hookshot_widgets_endpoint` | Widgets |
|
||||
|
||||
Also see the various `matrix_hookshot_container_labels_*` variables in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml), which expose URLs publicly.
|
||||
Also see the various `matrix_bridge_hookshot_container_labels_*` variables in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml), which expose URLs publicly.
|
||||
|
||||
The different listeners are also reachable *internally* in the docker-network via the container's name (configured by `matrix_hookshot_container_url`) and on different ports (e.g. `matrix_hookshot_appservice_port`). Read [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) in detail for more info.
|
||||
The different listeners are also reachable *internally* in the docker-network via the container's name (configured by `matrix_bridge_hookshot_container_url`) and on different ports (e.g. `matrix_bridge_hookshot_appservice_port`). Read [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) in detail for more info.
|
||||
|
||||
### Manage GitHub Private Key with aux role
|
||||
|
||||
The GitHub bridge requires you to install a private key file. This can be done in multiple ways:
|
||||
|
||||
- copy the *contents* of the downloaded file and set the variable `matrix_hookshot_github_private_key` to the contents (see example in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml)).
|
||||
- somehow copy the file to the path `{{ matrix_hookshot_base_path }}/{{ matrix_hookshot_github_private_key_file }}` (default: `/matrix/hookshot/private-key.pem`) on the server manually.
|
||||
- copy the *contents* of the downloaded file and set the variable `matrix_bridge_hookshot_github_private_key` to the contents (see example in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml)).
|
||||
- somehow copy the file to the path `{{ matrix_bridge_hookshot_base_path }}/{{ matrix_bridge_hookshot_github_private_key_file }}` (default: `/matrix/hookshot/private-key.pem`) on the server manually.
|
||||
- use the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux) to copy the file from an arbitrary path on your ansible client to the correct path on the server.
|
||||
|
||||
To use the `aux` role, make sure the `matrix_hookshot_github_private_key` variable is empty. Then add the following configuration to your `vars.yml` file:
|
||||
To use the `aux` role, make sure the `matrix_bridge_hookshot_github_private_key` variable is empty. Then add the following configuration to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
aux_file_definitions:
|
||||
- dest: "{{ matrix_hookshot_base_path }}/{{ matrix_hookshot_github_private_key_file }}"
|
||||
- dest: "{{ matrix_bridge_hookshot_base_path }}/{{ matrix_bridge_hookshot_github_private_key_file }}"
|
||||
content: "{{ lookup('file', '/path/to/your-github-private-key.pem') }}"
|
||||
mode: '0400'
|
||||
owner: "{{ matrix_user_name }}"
|
||||
@@ -139,23 +149,23 @@ To enable the metrics, add the following configuration to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
# Expose metrics (locally, on the container network).
|
||||
matrix_hookshot_metrics_enabled: true
|
||||
matrix_bridge_hookshot_metrics_enabled: true
|
||||
```
|
||||
|
||||
**To collect metrics from an external Prometheus server**, besides enabling metrics as described above, you will also need to enable metrics exposure on `https://matrix.example.com/metrics/hookshot` by adding the following configuration to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_hookshot_metrics_proxying_enabled: true
|
||||
matrix_bridge_hookshot_metrics_proxying_enabled: true
|
||||
```
|
||||
|
||||
By default metrics are exposed publicly **without** password-protection. To password-protect the metrics with dedicated credentials, add the following configuration to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_hookshot_container_labels_metrics_middleware_basic_auth_enabled: true
|
||||
matrix_hookshot_container_labels_metrics_middleware_basic_auth_users: ''
|
||||
matrix_bridge_hookshot_container_labels_metrics_middleware_basic_auth_enabled: true
|
||||
matrix_bridge_hookshot_container_labels_metrics_middleware_basic_auth_users: ''
|
||||
```
|
||||
|
||||
To `matrix_hookshot_container_labels_metrics_middleware_basic_auth_users`, set the Basic Authentication credentials (raw `htpasswd` file content) used to protect the endpoint. See https://doc.traefik.io/traefik/middlewares/http/basicauth/#users for details about it.
|
||||
To `matrix_bridge_hookshot_container_labels_metrics_middleware_basic_auth_users`, set the Basic Authentication credentials (raw `htpasswd` file content) used to protect the endpoint. See https://doc.traefik.io/traefik/middlewares/http/basicauth/#users for details about it.
|
||||
|
||||
**Note**: alternatively, you can use `matrix_metrics_exposure_enabled` to expose all services on this `/metrics/*` feature, and you can use `matrix_metrics_exposure_http_basic_auth_enabled` and `matrix_metrics_exposure_http_basic_auth_users` to password-protect the metrics of them. See [this section](configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) for more information.
|
||||
|
||||
@@ -175,5 +185,5 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# Valid values: error, warn, info, debug
|
||||
matrix_hookshot_logging_level: debug
|
||||
matrix_bridge_hookshot_logging_level: debug
|
||||
```
|
||||
|
||||
@@ -21,23 +21,23 @@ The bridge uses [android-sms-gateway-server](https://github.com/RebekkaMa/androi
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_sms_bridge_enabled: true
|
||||
matrix_bridge_sms_enabled: true
|
||||
|
||||
# (optional but recommended) a room ID to a default room
|
||||
matrix_sms_bridge_default_room: ""
|
||||
matrix_bridge_sms_default_room: ""
|
||||
|
||||
# (optional but recommended) configure your server location
|
||||
matrix_sms_bridge_default_region: DE
|
||||
matrix_sms_bridge_default_timezone: Europe/Berlin
|
||||
matrix_bridge_sms_default_region: DE
|
||||
matrix_bridge_sms_default_timezone: Europe/Berlin
|
||||
|
||||
# Settings to connect to android-sms-gateway-server
|
||||
matrix_sms_bridge_provider_android_baseurl: https://192.168.24.24:9090
|
||||
matrix_sms_bridge_provider_android_username: admin
|
||||
matrix_sms_bridge_provider_android_password: supeSecretPassword
|
||||
matrix_bridge_sms_provider_android_baseurl: https://192.168.24.24:9090
|
||||
matrix_bridge_sms_provider_android_username: admin
|
||||
matrix_bridge_sms_provider_android_password: supeSecretPassword
|
||||
|
||||
# (optional) if your android-sms-gateway-server uses a self signed vertificate, the bridge needs a "truststore". This can be the certificate itself.
|
||||
matrix_sms_bridge_provider_android_truststore_local_path: android-sms-gateway-server.p12
|
||||
matrix_sms_bridge_provider_android_truststore_password: 123
|
||||
matrix_bridge_sms_provider_android_truststore_local_path: android-sms-gateway-server.p12
|
||||
matrix_bridge_sms_provider_android_truststore_password: 123
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
@@ -46,7 +46,7 @@ There are some additional things you may wish to configure about the bridge.
|
||||
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bridge-sms/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_sms_bridge_configuration_extension_yaml` variable
|
||||
- `roles/custom/matrix-bridge-sms/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_sms_configuration_extension_yaml` variable
|
||||
|
||||
## Installing
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_bluesky_enabled: true
|
||||
matrix_bridge_mautrix_bluesky_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
@@ -70,5 +70,5 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug, trace
|
||||
matrix_mautrix_bluesky_logging_level: 'debug'
|
||||
matrix_bridge_mautrix_bluesky_logging_level: 'debug'
|
||||
```
|
||||
|
||||
@@ -21,12 +21,12 @@ To enable the bridge, add the following configuration to your `inventory/host_va
|
||||
|
||||
```yaml
|
||||
# Replace SERVICENAME with one of: twitter, discord, signal, googlechat, etc.
|
||||
matrix_mautrix_SERVICENAME_enabled: true
|
||||
matrix_bridge_mautrix_SERVICENAME_enabled: true
|
||||
```
|
||||
|
||||
**Note**: for bridging to Meta's Messenger or Instagram, you would need to add `meta` with an underscore symbol (`_`) or hyphen (`-`) based on the context as prefix to each `SERVICENAME`; add `_` to variables (as in `matrix_mautrix_meta_messenger_configuration_extension_yaml` for example) and `-` to paths of the configuration files (as in `roles/custom/matrix-bridge-mautrix-meta-messenger/templates/config.yaml.j2`), respectively.
|
||||
**Note**: for bridging to Meta's Messenger or Instagram, you would need to add `meta` with an underscore symbol (`_`) or hyphen (`-`) based on the context as prefix to each `SERVICENAME`; add `_` to variables (as in `matrix_bridge_mautrix_meta_messenger_configuration_extension_yaml` for example) and `-` to paths of the configuration files (as in `roles/custom/matrix-bridge-mautrix-meta-messenger/templates/config.yaml.j2`), respectively.
|
||||
|
||||
There are some additional things you may wish to configure about the bridge before you continue. Each bridge may have additional requirements besides `_enabled: true`. For example, the mautrix-telegram bridge (our documentation page about it is [here](configuring-playbook-bridge-mautrix-telegram.md)) requires the `matrix_mautrix_telegram_api_id` and `matrix_mautrix_telegram_api_hash` variables to be defined. Refer to each bridge's individual documentation page for details about enabling bridges.
|
||||
There are some additional things you may wish to configure about the bridge before you continue. Each bridge may have additional requirements besides `_enabled: true`. For example, the mautrix-telegram bridge (our documentation page about it is [here](configuring-playbook-bridge-mautrix-telegram.md)) requires the `matrix_bridge_mautrix_telegram_api_id` and `matrix_bridge_mautrix_telegram_api_hash` variables to be defined. Refer to each bridge's individual documentation page for details about enabling bridges.
|
||||
|
||||
### Configure bridge permissions (optional)
|
||||
|
||||
@@ -43,7 +43,7 @@ If you don't define the `matrix_admin` in your configuration (e.g. `matrix_admin
|
||||
**Alternatively** (more verbose, but allows multiple admins to be configured), you can do the same on a per-bridge basis with:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_SERVICENAME_configuration_extension_yaml: |
|
||||
matrix_bridge_mautrix_SERVICENAME_configuration_extension_yaml: |
|
||||
bridge:
|
||||
permissions:
|
||||
'@alice:{{ matrix_domain }}': admin
|
||||
@@ -67,8 +67,8 @@ matrix_bridges_encryption_default: true
|
||||
**Alternatively**, for a specific bridge:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_SERVICENAME_bridge_encryption_enabled: true
|
||||
matrix_mautrix_SERVICENAME_bridge_encryption_default: true
|
||||
matrix_bridge_mautrix_SERVICENAME_bridge_encryption_enabled: true
|
||||
matrix_bridge_mautrix_SERVICENAME_bridge_encryption_default: true
|
||||
```
|
||||
|
||||
### Enable relay mode (optional)
|
||||
@@ -86,16 +86,16 @@ matrix_bridges_relay_enabled: true
|
||||
**Alternatively**, for a specific bridge:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_SERVICENAME_configuration_extension_yaml: |
|
||||
matrix_bridge_mautrix_SERVICENAME_configuration_extension_yaml: |
|
||||
bridge:
|
||||
relay:
|
||||
enabled: true
|
||||
```
|
||||
|
||||
You can only have one `matrix_mautrix_SERVICENAME_configuration_extension_yaml` definition in `vars.yml` per bridge, so if you need multiple pieces of configuration there, just merge them like this:
|
||||
You can only have one `matrix_bridge_mautrix_SERVICENAME_configuration_extension_yaml` definition in `vars.yml` per bridge, so if you need multiple pieces of configuration there, just merge them like this:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_SERVICENAME_configuration_extension_yaml: |
|
||||
matrix_bridge_mautrix_SERVICENAME_configuration_extension_yaml: |
|
||||
bridge:
|
||||
relay:
|
||||
enabled: true
|
||||
@@ -115,7 +115,7 @@ Use `!prefix set-pl 100` to be able for the bot to modify room settings and invi
|
||||
By default, only admins are allowed to set themselves as relay users. To allow anyone on your homeserver to set themselves as relay users, add the following configuration to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_SERVICENAME_bridge_relay_admin_only: false
|
||||
matrix_bridge_mautrix_SERVICENAME_bridge_relay_admin_only: false
|
||||
```
|
||||
|
||||
### Set the bot's username (optional)
|
||||
@@ -123,7 +123,7 @@ matrix_mautrix_SERVICENAME_bridge_relay_admin_only: false
|
||||
To set the bot's username, add the following configuration to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_SERVICENAME_appservice_bot_username: "BOTNAME"
|
||||
matrix_bridge_mautrix_SERVICENAME_appservice_bot_username: "BOTNAME"
|
||||
```
|
||||
|
||||
### Configure the logging level (optional)
|
||||
@@ -131,13 +131,42 @@ matrix_mautrix_SERVICENAME_appservice_bot_username: "BOTNAME"
|
||||
To specify the logging level, add the following configuration to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_SERVICENAME_logging_level: warn
|
||||
matrix_bridge_mautrix_SERVICENAME_logging_level: warn
|
||||
```
|
||||
|
||||
Replace `warn` with one of the following to control the verbosity of the logs generated: `trace`, `debug`, `info`, `warn`, `error` or `fatal`.
|
||||
|
||||
If you have issues with a service, and are requesting support, the higher levels of logging (those that appear earlier in the list, like `trace`) will generally be more helpful.
|
||||
|
||||
### Expose the bridge's API (for Mautrix Manager and similar tools)
|
||||
|
||||
Each mautrix bridge runs an HTTP API which tools like [Mautrix Manager](https://github.com/mautrix/manager) can use to help you log into the bridge. This is especially handy for bridges where logging in manually is cumbersome (like [mautrix-gmessages](configuring-playbook-bridge-mautrix-gmessages.md)).
|
||||
|
||||
By default, the playbook exposes this API publicly at `https://matrix.example.com/bridges/SERVICENAME` (for example, `https://matrix.example.com/bridges/gmessages`). Such tools authenticate to the bridge with your own Matrix access token, so you never need to share any bridge secret with them.
|
||||
|
||||
To make discovery easier, the playbook also serves a `/.well-known/matrix/mautrix` file which advertises all your exposed bridges. Mautrix Manager reads this file and offers your bridges automatically, so you don't need to enter their URLs by hand.
|
||||
|
||||
This is all enabled by default. To **disable exposing the API for all bridges**, add the following configuration to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_bridges_exposure_enabled: false
|
||||
```
|
||||
|
||||
**Alternatively**, to disable it for a specific bridge:
|
||||
|
||||
```yaml
|
||||
matrix_bridge_mautrix_SERVICENAME_exposure_enabled: false
|
||||
```
|
||||
|
||||
If you run additional bridges on the same server which are not managed by this playbook and would like compatible tools to discover them as well, you can advertise their base URLs in the `/.well-known/matrix/mautrix` file:
|
||||
|
||||
```yaml
|
||||
matrix_static_files_file_matrix_mautrix_property_fi_mau_bridges_custom:
|
||||
- https://matrix.example.com/bridges/SOME_OTHER_BRIDGE
|
||||
```
|
||||
|
||||
Only list bridges hosted on (and connected to) this server here, as compatible tools will send your Matrix access token to them. For bridges on other servers, take a look at the `fi.mau.external_bridge_servers` property described in the [Mautrix Manager](https://github.com/mautrix/manager) documentation, which you can add via `matrix_static_files_file_matrix_mautrix_configuration_extension_json`.
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the bridge.
|
||||
@@ -145,7 +174,7 @@ There are some additional things you may wish to configure about the bridge.
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bridge-mautrix-SERVICENAME/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
- `roles/custom/matrix-bridge-mautrix-SERVICENAME/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_mautrix_SERVICENAME_configuration_extension_yaml` variable
|
||||
- `roles/custom/matrix-bridge-mautrix-SERVICENAME/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_mautrix_SERVICENAME_configuration_extension_yaml` variable
|
||||
|
||||
## Installing
|
||||
|
||||
@@ -197,7 +226,7 @@ This is the recommended way of setting up Double Puppeting, as it's easier to ac
|
||||
- Previously there were multiple different automatic double puppeting methods like one with the help of the [Shared Secret Auth password provider module](./configuring-playbook-shared-secret-auth.md), but they have been superseded by this Appservice Double Puppet method. Double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future as the older methods were completely removed in the megabridge rewrites on [the upstream project](https://docs.mau.fi/bridges/general/double-puppeting.html#automatically).
|
||||
|
||||
<!-- TODO: remove this note if the Shared Secret Auth service has stopped working or the bridges have been removed -->
|
||||
- Some bridges like [the deprecated Facebook mautrix bridge](configuring-playbook-bridge-mautrix-facebook.md) and [matrix-appservice-kakaotalk](configuring-playbook-bridge-appservice-kakaotalk.md), which is partially based on the Facebook bridge, are compatible with the Shared Secret Auth service only. These bridges automatically perform Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook.
|
||||
- Some bridges like [the deprecated Facebook mautrix bridge](configuring-playbook-bridge-mautrix-facebook.md) are compatible with the Shared Secret Auth service only. These bridges automatically perform Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook.
|
||||
|
||||
#### Method 2: manually, by asking each user to provide a working access token
|
||||
|
||||
|
||||
@@ -39,7 +39,7 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_discord_enabled: true
|
||||
matrix_bridge_mautrix_discord_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
@@ -96,7 +96,7 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug, trace
|
||||
matrix_mautrix_discord_logging_level: 'debug'
|
||||
matrix_bridge_mautrix_discord_logging_level: 'debug'
|
||||
```
|
||||
|
||||
### Command requires room admin rights when user is creator
|
||||
|
||||
@@ -27,7 +27,7 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_gmessages_enabled: true
|
||||
matrix_bridge_mautrix_gmessages_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
@@ -68,5 +68,5 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug, trace
|
||||
matrix_mautrix_gmessages_logging_level: 'debug'
|
||||
matrix_bridge_mautrix_gmessages_logging_level: 'debug'
|
||||
```
|
||||
|
||||
@@ -30,7 +30,7 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the [Google Chat](https://chat.google.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_googlechat_enabled: true
|
||||
matrix_bridge_mautrix_googlechat_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
@@ -70,5 +70,5 @@ As with all other services, you can find the logs in [systemd-journald](https://
|
||||
The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_googlechat_logging_level: DEBUG
|
||||
matrix_bridge_mautrix_googlechat_logging_level: DEBUG
|
||||
```
|
||||
|
||||
@@ -0,0 +1,73 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2026 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2026 Nikita Chernyi
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up Mautrix Google Voice bridging (optional)
|
||||
|
||||
<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>
|
||||
|
||||
The playbook can install and configure [mautrix-gvoice](https://github.com/mautrix/gvoice) for you, for bridging to [Google Voice](https://voice.google.com/).
|
||||
|
||||
See the project's [documentation](https://docs.mau.fi/bridges/go/gvoice/index.html) to learn what it does and why it might be useful to you.
|
||||
|
||||
## Prerequisite (optional)
|
||||
|
||||
### Enable Appservice Double Puppet
|
||||
|
||||
If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) for this playbook.
|
||||
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_bridge_mautrix_gvoice_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the bridge.
|
||||
|
||||
<!-- NOTE: relay mode is not supported for this bridge -->
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc.
|
||||
|
||||
## Installing
|
||||
|
||||
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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, start a chat with `@gvoicebot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
Google Voice has no phone to pair and no QR code to scan. It logs in with cookies, which you copy from a browser already signed in to [voice.google.com](https://voice.google.com/) and hand to the bot. It is fiddlier than scanning a code and feels more suspicious than it is, but Google leaves no cleaner door open. The bridge's [official Authentication guide](https://docs.mau.fi/bridges/go/gvoice/authentication.html) has the exact cookies to grab and the steps for grabbing them.
|
||||
|
||||
Those cookies are a login session, and Google expires them on its own schedule. When they lapse the bridge goes quiet and you log in again. Nothing is broken, that is just how cookie auth ages.
|
||||
|
||||
Once you log in, the bridge builds portal rooms for your recent conversations and carries text and media both ways. Don't reach for it to start a brand-new chat or to place a call, though. That ground still belongs to Google Voice, so keep the app around for those.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-mautrix-gvoice`.
|
||||
|
||||
### Increase logging verbosity
|
||||
|
||||
The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug, trace
|
||||
matrix_bridge_mautrix_gvoice_logging_level: 'debug'
|
||||
```
|
||||
@@ -23,7 +23,7 @@ This documentation page only deals with the bridge's ability to bridge to Instag
|
||||
|
||||
If you've been using the [mautrix-instagram](./configuring-playbook-bridge-mautrix-instagram.md) bridge, **you'd better get rid of it first** or the 2 bridges will be in conflict:
|
||||
|
||||
- both trying to use `@instagrambot:example.com` as their username. This conflict may be resolved by adjusting `matrix_mautrix_instagram_appservice_bot_username` or `matrix_mautrix_meta_instagram_appservice_username`
|
||||
- both trying to use `@instagrambot:example.com` as their username. This conflict may be resolved by adjusting `matrix_mautrix_instagram_appservice_bot_username` or `matrix_bridge_mautrix_meta_instagram_appservice_username`
|
||||
- both trying to bridge the same DMs
|
||||
|
||||
To do so, send a `clean-rooms` command to the management room with the old bridge bot (`@instagrambot:example.com`). It gives you a list of portals and groups of portals you may purge. Proceed with sending commands like `clean recommended`, etc.
|
||||
@@ -41,7 +41,7 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_meta_instagram_enabled: true
|
||||
matrix_bridge_mautrix_meta_instagram_enabled: true
|
||||
```
|
||||
|
||||
Before proceeding to [re-running the playbook](./installing.md), you may wish to adjust the configuration further. See below.
|
||||
@@ -83,5 +83,5 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# This bridge uses zerolog, so valid levels are: panic, fatal, error, warn, info, debug, trace
|
||||
matrix_mautrix_meta_instagram_logging_min_level: debug
|
||||
matrix_bridge_mautrix_meta_instagram_logging_min_level: debug
|
||||
```
|
||||
|
||||
@@ -41,7 +41,7 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_meta_messenger_enabled: true
|
||||
matrix_bridge_mautrix_meta_messenger_enabled: true
|
||||
```
|
||||
|
||||
Before proceeding to [re-running the playbook](./installing.md), you may wish to adjust the configuration further. See below.
|
||||
@@ -56,7 +56,7 @@ The bridge can pull your Messenger messages via 3 different methods:
|
||||
- (`facebook-tor`) Facebook via `facebookwkhpilnemxj7asaniu7vnjjbiltxjqhye3mhbshg7kx5tfyd.onion` ([Tor](https://www.torproject.org/)) — does not currently proxy media downloads
|
||||
- (default) (`messenger`) Messenger via `messenger.com` — usable even without a Facebook account
|
||||
|
||||
You may switch the mode via the `matrix_mautrix_meta_messenger_meta_mode` variable. The playbook defaults to the `messenger` mode, because it's most universal (every Facebook user has a Messenger account, but the opposite is not true).
|
||||
You may switch the mode via the `matrix_bridge_mautrix_meta_messenger_meta_mode` variable. The playbook defaults to the `messenger` mode, because it's most universal (every Facebook user has a Messenger account, but the opposite is not true).
|
||||
|
||||
Note that switching the mode (especially between `facebook*` and `messenger`) will intentionally make the bridge use another database (`matrix_mautrix_meta_facebook` or `matrix_mautrix_meta_messenger`) to isolate the 2 instances. Switching between Tor and non-Tor may be possible without dataloss, but your mileage may vary. Before switching to a new mode, you may wish to de-configure the old one (send `help` to the bridge bot and unbridge your portals, etc.).
|
||||
|
||||
@@ -99,5 +99,5 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# This bridge uses zerolog, so valid levels are: panic, fatal, error, warn, info, debug, trace
|
||||
matrix_mautrix_meta_messenger_logging_min_level: debug
|
||||
matrix_bridge_mautrix_meta_messenger_logging_min_level: debug
|
||||
```
|
||||
|
||||
@@ -28,7 +28,7 @@ See the project's [documentation](https://docs.mau.fi/bridges/go/signal/index.ht
|
||||
|
||||
If you're running with the Postgres database server integrated by the playbook (which is the default), you don't need to do anything special and can easily proceed with installing.
|
||||
|
||||
However, if you're [using an external Postgres server](configuring-playbook-external-postgres.md), you'd need to manually prepare a Postgres database for this bridge and adjust the variables related to that (`matrix_mautrix_signal_database_*`).
|
||||
However, if you're [using an external Postgres server](configuring-playbook-external-postgres.md), you'd need to manually prepare a Postgres database for this bridge and adjust the variables related to that (`matrix_bridge_mautrix_signal_database_*`).
|
||||
|
||||
### Enable Appservice Double Puppet
|
||||
|
||||
@@ -41,7 +41,7 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_signal_enabled: true
|
||||
matrix_bridge_mautrix_signal_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
@@ -83,5 +83,5 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug, trace
|
||||
matrix_mautrix_signal_logging_level: 'debug'
|
||||
matrix_bridge_mautrix_signal_logging_level: 'debug'
|
||||
```
|
||||
|
||||
@@ -34,7 +34,7 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_slack_enabled: true
|
||||
matrix_bridge_mautrix_slack_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
@@ -74,5 +74,5 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug, trace
|
||||
matrix_mautrix_slack_logging_level: 'debug'
|
||||
matrix_bridge_mautrix_slack_logging_level: 'debug'
|
||||
```
|
||||
|
||||
@@ -36,9 +36,9 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `YOUR_TELEGRAM_APP_ID` and `YOUR_TELEGRAM_API_HASH`.
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_telegram_enabled: true
|
||||
matrix_mautrix_telegram_api_id: YOUR_TELEGRAM_APP_ID
|
||||
matrix_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH
|
||||
matrix_bridge_mautrix_telegram_enabled: true
|
||||
matrix_bridge_mautrix_telegram_api_id: YOUR_TELEGRAM_APP_ID
|
||||
matrix_bridge_mautrix_telegram_api_hash: YOUR_TELEGRAM_API_HASH
|
||||
```
|
||||
|
||||
### Relaying
|
||||
@@ -86,5 +86,5 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug, trace
|
||||
matrix_mautrix_telegram_logging_level: debug
|
||||
matrix_bridge_mautrix_telegram_logging_level: debug
|
||||
```
|
||||
|
||||
@@ -28,7 +28,7 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_twitter_enabled: true
|
||||
matrix_bridge_mautrix_twitter_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
@@ -69,5 +69,5 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug, trace
|
||||
matrix_mautrix_twitter_logging_level: 'debug'
|
||||
matrix_bridge_mautrix_twitter_logging_level: 'debug'
|
||||
```
|
||||
|
||||
@@ -34,7 +34,7 @@ See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_whatsapp_enabled: true
|
||||
matrix_bridge_mautrix_whatsapp_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
@@ -76,5 +76,5 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug, trace
|
||||
matrix_mautrix_whatsapp_logging_level: 'debug'
|
||||
matrix_bridge_mautrix_whatsapp_logging_level: 'debug'
|
||||
```
|
||||
|
||||
@@ -25,26 +25,26 @@ When setting, replace `example.com` with your own.
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mautrix_wsproxy_enabled: true
|
||||
matrix_bridge_mautrix_wsproxy_enabled: true
|
||||
|
||||
matrix_mautrix_androidsms_appservice_token: 'secret token from bridge'
|
||||
matrix_mautrix_androidsms_homeserver_token: 'secret token from bridge'
|
||||
matrix_mautrix_imessage_appservice_token: 'secret token from bridge'
|
||||
matrix_mautrix_imessage_homeserver_token: 'secret token from bridge'
|
||||
matrix_mautrix_wsproxy_syncproxy_shared_secret: 'secret token from bridge'
|
||||
matrix_bridge_mautrix_wsproxy_androidsms_appservice_token: 'secret token from bridge'
|
||||
matrix_bridge_mautrix_wsproxy_androidsms_homeserver_token: 'secret token from bridge'
|
||||
matrix_bridge_mautrix_wsproxy_imessage_appservice_token: 'secret token from bridge'
|
||||
matrix_bridge_mautrix_wsproxy_imessage_homeserver_token: 'secret token from bridge'
|
||||
matrix_bridge_mautrix_wsproxy_syncproxy_shared_secret: 'secret token from bridge'
|
||||
```
|
||||
|
||||
Note that the tokens must match what is compiled into the [mautrix-imessage](https://github.com/mautrix/imessage) bridge running on your Mac or Android device.
|
||||
|
||||
### Adjusting the wsproxy URL (optional)
|
||||
|
||||
By tweaking the `matrix_mautrix_wsproxy_hostname` variable, you can easily make the service available at a **different hostname** than the default one.
|
||||
By tweaking the `matrix_bridge_mautrix_wsproxy_hostname` variable, you can easily make the service available at a **different hostname** than the default one.
|
||||
|
||||
Example additional configuration for your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
# Change the default hostname
|
||||
matrix_mautrix_wsproxy_hostname: ws.example.com
|
||||
matrix_bridge_mautrix_wsproxy_hostname: ws.example.com
|
||||
```
|
||||
|
||||
After changing the domain, **you may need to adjust your DNS** records to point the wsproxy domain to the Matrix server.
|
||||
|
||||
@@ -26,42 +26,42 @@ You also need access to a Meshtastic device, connected to the server via one of:
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_meshtastic_relay_enabled: true
|
||||
matrix_bridge_meshtastic_relay_enabled: true
|
||||
|
||||
# Password for the bot's Matrix account.
|
||||
# On first startup, the bridge uses this to log in and persist credentials
|
||||
# (including End-to-End Encryption material) under its data directory.
|
||||
# After that, the password can be removed from this variable.
|
||||
matrix_meshtastic_relay_matrix_bot_password: "PASSWORD_FOR_THE_BOT"
|
||||
matrix_bridge_meshtastic_relay_matrix_bot_password: "PASSWORD_FOR_THE_BOT"
|
||||
|
||||
# How the bridge connects to your Meshtastic device.
|
||||
# One of: tcp, serial, ble
|
||||
matrix_meshtastic_relay_connection_type: tcp
|
||||
matrix_bridge_meshtastic_relay_connection_type: tcp
|
||||
|
||||
# For connection_type: tcp
|
||||
matrix_meshtastic_relay_tcp_host: "meshtastic.local"
|
||||
matrix_bridge_meshtastic_relay_tcp_host: "meshtastic.local"
|
||||
|
||||
# For connection_type: serial
|
||||
# matrix_meshtastic_relay_serial_port: "/dev/ttyUSB0"
|
||||
# matrix_bridge_meshtastic_relay_serial_port: "/dev/ttyUSB0"
|
||||
|
||||
# For connection_type: ble
|
||||
# matrix_meshtastic_relay_ble_address: "AA:BB:CC:DD:EE:FF"
|
||||
# matrix_bridge_meshtastic_relay_ble_address: "AA:BB:CC:DD:EE:FF"
|
||||
|
||||
# Matrix rooms to bridge to Meshtastic channels.
|
||||
matrix_meshtastic_relay_matrix_rooms_list:
|
||||
matrix_bridge_meshtastic_relay_matrix_rooms_list:
|
||||
- id: "#meshtastic:{{ matrix_domain }}"
|
||||
meshtastic_channel: "0"
|
||||
```
|
||||
|
||||
By default, the bot's Matrix ID is `@meshtasticbot:{{ matrix_domain }}`. To change it, adjust `matrix_meshtastic_relay_matrix_bot_user_id`.
|
||||
By default, the bot's Matrix ID is `@meshtasticbot:{{ matrix_domain }}`. To change it, adjust `matrix_bridge_meshtastic_relay_matrix_bot_user_id`.
|
||||
|
||||
### Bluetooth (BLE) connections
|
||||
|
||||
When `matrix_meshtastic_relay_connection_type` is `ble`, the container runs with `--network=host` and bind-mounts the host's DBus socket — both are required for Bluetooth pairing/communication. Only use this connection type if you trust the playbook-managed host and are comfortable with these privileges.
|
||||
When `matrix_bridge_meshtastic_relay_connection_type` is `ble`, the container runs with `--network=host` and bind-mounts the host's DBus socket — both are required for Bluetooth pairing/communication. Only use this connection type if you trust the playbook-managed host and are comfortable with these privileges.
|
||||
|
||||
### Serial connections
|
||||
|
||||
When `matrix_meshtastic_relay_connection_type` is `serial`, the host device referenced by `matrix_meshtastic_relay_serial_port` is passed through to the container. Make sure that `matrix_user_uid` / `matrix_user_gid` have read/write access to that device (e.g. by adding the matrix user to the `dialout` group, or adjusting udev rules).
|
||||
When `matrix_bridge_meshtastic_relay_connection_type` is `serial`, the host device referenced by `matrix_bridge_meshtastic_relay_serial_port` is passed through to the container. Make sure that `matrix_user_uid` / `matrix_user_gid` have read/write access to that device (e.g. by adding the matrix user to the `dialout` group, or adjusting udev rules).
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
@@ -69,7 +69,7 @@ There are some additional things you may wish to configure about the bridge.
|
||||
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bridge-meshtastic-relay/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override individual `matrix_meshtastic_relay_*` variables, or make finer-grained adjustments via `matrix_meshtastic_relay_configuration_extension_yaml`.
|
||||
- `roles/custom/matrix-bridge-meshtastic-relay/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override individual `matrix_bridge_meshtastic_relay_*` variables, or make finer-grained adjustments via `matrix_bridge_meshtastic_relay_configuration_extension_yaml`.
|
||||
|
||||
## Installing
|
||||
|
||||
@@ -86,7 +86,7 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju
|
||||
|
||||
## Usage
|
||||
|
||||
Invite the bot to the Matrix rooms listed in `matrix_meshtastic_relay_matrix_rooms_list` and it will relay between Matrix and the corresponding Meshtastic channel. Messages sent on Meshtastic will appear in Matrix and vice versa.
|
||||
Invite the bot to the Matrix rooms listed in `matrix_bridge_meshtastic_relay_matrix_rooms_list` and it will relay between Matrix and the corresponding Meshtastic channel. Messages sent on Meshtastic will appear in Matrix and vice versa.
|
||||
|
||||
See the [project's wiki](https://github.com/jeremiah-k/meshtastic-matrix-relay/wiki) for details about commands, plugins and advanced usage.
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ See the project's [documentation](https://gitlab.com/xangelix-pub/matrix/mx-pupp
|
||||
To enable the [GroupMe](https://groupme.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mx_puppet_groupme_enabled: true
|
||||
matrix_bridge_mx_puppet_groupme_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
@@ -20,7 +20,7 @@ See the project's [documentation](https://codeberg.org/icewind/mx-puppet-steam/b
|
||||
To enable the [Steam](https://steampowered.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_mx_puppet_steam_enabled: true
|
||||
matrix_bridge_mx_puppet_steam_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
|
||||
@@ -24,7 +24,7 @@ Open the following ports on your server to be able to receive incoming emails:
|
||||
|
||||
If you don't open these ports, you will still be able to send emails, but not receive any.
|
||||
|
||||
These port numbers are configurable via the `matrix_postmoogle_smtp_host_bind_port` and `matrix_postmoogle_submission_host_bind_port` variables, but other email servers will try to deliver on these default (standard) ports, so changing them is of little use.
|
||||
These port numbers are configurable via the `matrix_bridge_postmoogle_smtp_host_bind_port` and `matrix_bridge_postmoogle_submission_host_bind_port` variables, but other email servers will try to deliver on these default (standard) ports, so changing them is of little use.
|
||||
|
||||
## Adjusting DNS records
|
||||
|
||||
@@ -44,17 +44,17 @@ To make Postmoogle enable its email sending features, you need to configure MX a
|
||||
Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_postmoogle_enabled: true
|
||||
matrix_bridge_postmoogle_enabled: true
|
||||
|
||||
# Uncomment and adjust this part if you'd like to use a username different than the default
|
||||
# matrix_postmoogle_login: postmoogle
|
||||
# matrix_bridge_postmoogle_login: postmoogle
|
||||
|
||||
# Generate a strong password for the bot. You can create one with a command like `pwgen -s 64 1`.
|
||||
matrix_postmoogle_password: PASSWORD_FOR_THE_BOT
|
||||
matrix_bridge_postmoogle_password: PASSWORD_FOR_THE_BOT
|
||||
|
||||
# Uncomment to add one or more admins to this bridge:
|
||||
#
|
||||
# matrix_postmoogle_admins:
|
||||
# matrix_bridge_postmoogle_admins:
|
||||
# - '@yourAdminAccount:{{ matrix_domain }}'
|
||||
#
|
||||
# … unless you've made yourself an admin of all bots/bridges like this:
|
||||
@@ -87,7 +87,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use
|
||||
|
||||
`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed.
|
||||
|
||||
- If you change the bridge's bot password (`matrix_postmoogle_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [Ketesa](configuring-playbook-ketesa.md) to change it, and then update `matrix_postmoogle_password` to let the bot know its new password.
|
||||
- If you change the bridge's bot password (`matrix_bridge_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 [Ketesa](configuring-playbook-ketesa.md) to change it, and then update `matrix_bridge_postmoogle_password` to let the bot know its new password.
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -108,5 +108,5 @@ As with all other services, you can find the logs in [systemd-journald](https://
|
||||
The default logging level for this component is `INFO`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
matrix_postmoogle_loglevel: 'DEBUG'
|
||||
matrix_bridge_postmoogle_loglevel: 'DEBUG'
|
||||
```
|
||||
|
||||
@@ -0,0 +1,100 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2026 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2026 Jason LaGuidice
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up RustPush (iMessage) bridging (optional)
|
||||
|
||||
> **Note:** This bridge is in early development and may have stability issues. It may not be desirable to deploy this to a large number of users. Your testing and feedback is appreciated.
|
||||
|
||||
<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>
|
||||
|
||||
The playbook can install and configure [RustPush bridge to iMessage](https://github.com/jasonlaguidice/imessage) for you using Apple's push notification service.
|
||||
|
||||
See the project's [documentation](https://github.com/jasonlaguidice/imessage/blob/main/README.md) to learn what it does and why it might be useful to you.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
### Hardware Key Extraction
|
||||
|
||||
To use this bridge on Linux (Docker), each user needs a **hardware key** extracted from a real Mac. This key contains hardware identifiers needed for iMessage registration. Hardware keys can be shared by a number of users (approximately 20) before causing issues with Apple.
|
||||
|
||||
The key is entered interactively through the bridge bot's login flow (not configured via Ansible variables). See the upstream [README](https://github.com/jasonlaguidice/imessage/blob/main/README.md) for instructions on extracting the key.
|
||||
|
||||
If extracted from an Intel Mac, the Mac does not need to remain running after the key is extracted for this bridge to work. Apple Silicon Macs must run a NAC relay and thus must remain running.
|
||||
|
||||
### Phone Number Registration (optional)
|
||||
|
||||
This bridge can **not** do phone number registration (PNR). The only way to have your phone number registered and used (instead of an Apple ID e-mail address) is to have an iPhone connected to your Apple account. Reference the [BlueBubbles Phone Number Registration Guide](https://docs.bluebubbles.app/server/advanced/registering-a-phone-number-with-your-imessage-account) for information on how to set this up.
|
||||
|
||||
### Enable Appservice Double Puppet (optional)
|
||||
|
||||
If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook.
|
||||
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_bridge_rustpush_enabled: true
|
||||
```
|
||||
|
||||
### Disable Backfill (optional)
|
||||
|
||||
Backfill can be disabled globally if desired via config. By default, the bridge will backfill from iCloud (CloudKit) and APNS if available. Backfill from `chat.db` is only possible when the bridge is running on MacOS.
|
||||
|
||||
```yaml
|
||||
matrix_bridge_rustpush_backfill_enabled: false
|
||||
```
|
||||
|
||||
### Extending the Configuration
|
||||
|
||||
There are some additional things you may wish to configure about the bridge.
|
||||
|
||||
See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc.
|
||||
|
||||
## Installing
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
**Notes**:
|
||||
|
||||
- The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed.
|
||||
|
||||
## Usage
|
||||
|
||||
To use the bridge, you need to start a chat with `@rustpushbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain).
|
||||
|
||||
After logging in, the bridge will start receiving iMessages and creating portal rooms.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-rustpush-bridge`.
|
||||
|
||||
### Increase logging verbosity
|
||||
|
||||
The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug, trace
|
||||
matrix_bridge_rustpush_logging_level: 'debug'
|
||||
|
||||
# Enable debug logging for RustPush
|
||||
matrix_bridge_rustpush_rust_log: "warn,rustpushgo=info,openabsinthe=debug"
|
||||
```
|
||||
## Notable Configuration Options
|
||||
- `matrix_bridge_rustpush_statuskit_notifications` will display StatusKit information for conversation participants. In some clients, this update will cause the DM to be pushed to the top of the conversation list continuously, so this option is disabled by default.
|
||||
- `matrix_bridge_rustpush_statuskit_notification_style` can be set to either `topic` or `notice`
|
||||
- `topic` sets the status as a room topic. In supported clients (like Cinny and Sable), this will display `🔕 Focus` as a second line when the person has focus mode enabled.
|
||||
- `notice` sends an `m.notice` event to the room which will display text in the room but should not generate a notification
|
||||
@@ -15,7 +15,7 @@ See the project's [documentation](https://github.com/jasonlaguidice/matrix-steam
|
||||
To enable the [Steam](https://steampowered.com/) bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_steam_bridge_enabled: true
|
||||
matrix_bridge_steam_enabled: true
|
||||
```
|
||||
|
||||
## Installing
|
||||
@@ -46,3 +46,6 @@ Once logged in, send `search [name]` to search through recognized Steam friends.
|
||||
Chat rooms will automatically be opened as new messages are received.
|
||||
|
||||
Send `help` to the bot to see the available commands.
|
||||
|
||||
## Notable Configuration Options
|
||||
- `matrix_bridge_steam_network_presence_topic_enabled` and `matrix_bridge_steam_network_presence_topic_rich_presence_enabled` mirror Steam's [Enhanced Rich Presence](https://partner.steamgames.com/doc/features/enhancedrichpresence) feature in Matrix. This will display the user's current game and rich presence if supported by the game. This sets the DM room's `m.topic` field to achieve this. Some games (like Deadlock) update the rich presence every minute with a match timer. In some clients, the topic update will cause the DM to be pushed to the top of the conversation list continuously, so this option is disabled by default.
|
||||
|
||||
@@ -19,7 +19,7 @@ See the project's [documentation](https://github.com/duo/matrix-wechat/blob/mast
|
||||
To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_wechat_enabled: true
|
||||
matrix_bridge_wechat_enabled: true
|
||||
```
|
||||
|
||||
### Extending the configuration
|
||||
@@ -29,7 +29,7 @@ There are some additional things you may wish to configure about the bridge.
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-bridge-wechat/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
- `roles/custom/matrix-bridge-wechat/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_wechat_configuration_extension_yaml` variable
|
||||
- `roles/custom/matrix-bridge-wechat/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_wechat_configuration_extension_yaml` variable
|
||||
|
||||
## Installing
|
||||
|
||||
@@ -62,5 +62,5 @@ The default logging level for this component is `warn`. If you want to increase
|
||||
|
||||
```yaml
|
||||
# Valid values: fatal, error, warn, info, debug
|
||||
matrix_wechat_log_level: 'debug'
|
||||
matrix_bridge_wechat_log_level: 'debug'
|
||||
```
|
||||
|
||||
@@ -0,0 +1,93 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2026 MDAD project contributors
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Setting up Commet (optional)
|
||||
|
||||
The playbook can install and configure the [Commet](https://github.com/commetchat/commet) Matrix web client for you.
|
||||
|
||||
## Adjusting DNS records
|
||||
|
||||
By default, this playbook installs Commet on the `commet.` subdomain (`commet.example.com`) and requires you to create a CNAME record for `commet`, which targets `matrix.example.com`.
|
||||
|
||||
When setting, replace `example.com` with your own.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
To enable Commet, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_client_commet_enabled: true
|
||||
```
|
||||
|
||||
### Adjusting the Commet URL (optional)
|
||||
|
||||
By tweaking the `matrix_client_commet_hostname` and `matrix_client_commet_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one.
|
||||
|
||||
Example additional configuration for your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
# Switch to the domain used for Matrix services (`matrix.example.com`),
|
||||
# so we won't need to add additional DNS records for Commet.
|
||||
matrix_client_commet_hostname: "{{ matrix_server_fqn_matrix }}"
|
||||
|
||||
# Expose under the /commet subpath
|
||||
matrix_client_commet_path_prefix: /commet
|
||||
```
|
||||
|
||||
After changing the domain, **you may need to adjust your DNS** records to point the Commet domain to the Matrix server.
|
||||
|
||||
If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration.
|
||||
|
||||
**Note**: `matrix_client_commet_path_prefix` must either be `/` or not end with a slash (e.g. `/commet`).
|
||||
|
||||
### Adjusting the default homeserver (optional)
|
||||
|
||||
Commet is configured with a `default_homeserver` value. By default, the playbook uses `matrix.org`.
|
||||
|
||||
To change it, add the following configuration to your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
matrix_client_commet_default_homeserver: "{{ matrix_domain }}"
|
||||
```
|
||||
|
||||
### Adjusting the Commet version/branch to build (optional)
|
||||
|
||||
When self-building the container image (`matrix_client_commet_container_image_self_build: true`), the playbook checks out the Commet source repository and builds an image from it.
|
||||
|
||||
To build from a different git branch/tag/SHA, set `matrix_client_commet_version` in your `vars.yml` file:
|
||||
|
||||
```yaml
|
||||
# Examples: "main", "v1.2.3", "feature-branch", "a1b2c3d4"
|
||||
matrix_client_commet_version: "main"
|
||||
```
|
||||
|
||||
**Note**: by default, the image tag is derived from `matrix_client_commet_version` (`localhost/matrix-client-commet:{{ matrix_client_commet_version }}`). If your branch name contains `/` (e.g. `feature/foo`), override `matrix_client_commet_container_image` (and optionally `matrix_client_commet_container_image_self_build_version_tag`) to a Docker-tag-safe value.
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the component.
|
||||
|
||||
Take a look at:
|
||||
|
||||
- `roles/custom/matrix-client-commet/defaults/main.yml` for some variables that you can customize via your `vars.yml` file
|
||||
- `roles/custom/matrix-client-commet/templates/global_config.json.j2` for the component's default runtime configuration
|
||||
|
||||
## Installing
|
||||
|
||||
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 the [`just` program](just.md) are also available: `just install-all` or `just setup-all`
|
||||
|
||||
`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-client-commet`.
|
||||
@@ -8,7 +8,7 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Setting up Sable (optional)
|
||||
|
||||
The playbook can install and configure the [Sable](https://github.com/7w1/sable) Matrix web client for you.
|
||||
The playbook can install and configure the [Sable](https://github.com/SableClient/Sable) Matrix web client for you.
|
||||
|
||||
Sable is a web client focusing primarily on simple, elegant and secure interface. It can be installed alongside or instead of [Element Web](./configuring-playbook-client-element-web.md), [Cinny](./configuring-playbook-client-cinny.md) and others.
|
||||
|
||||
|
||||
@@ -71,4 +71,6 @@ matrix_synapse_federation_port_enabled: false
|
||||
matrix_synapse_tls_federation_listener_enabled: false
|
||||
```
|
||||
|
||||
**Note**: `matrix_synapse_federation_port_enabled: false` only makes sense in this specific setup, where federation traffic is served through the client port (because of the `federation` entry in `matrix_synapse_http_listener_resource_names`). If federation still flows through the dedicated federation port on your setup (e.g. another reverse proxy of yours forwarding a custom public port to this playbook's federation port), leave `matrix_synapse_federation_port_enabled` at its default (enabled). Disabling it removes the federation route entirely and breaks such setups.
|
||||
|
||||
**Use this at you own risk as all the possible side-effects of doing this are not fully known. However, it has been tested and works fine and passes all the tests on <https://federationtester.matrix.org/> without issues.**
|
||||
|
||||
@@ -13,14 +13,14 @@ SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
|
||||
# Setting up Ketesa (optional)
|
||||
|
||||
The playbook can install and configure [Ketesa](https://github.com/etkecc/ketesa) for you.
|
||||
The playbook can install and configure [Ketesa](https://ketesa.app) ([source code](https://github.com/etkecc/ketesa)) for you.
|
||||
|
||||
Ketesa is a fully-featured admin interface for Matrix homeservers — manage users, rooms, media, sessions, and more from one clean, responsive web UI. It is the evolution of [Awesome-Technologies/synapse-admin](https://github.com/Awesome-Technologies/synapse-admin): what began as a fork has grown into its own independent project with a redesigned interface, comprehensive Synapse and MAS API coverage, and multi-language support. See the [Ketesa v1.0.0 announcement](https://etke.cc/blog/introducing-ketesa/) for a full overview of what's new.
|
||||
|
||||
>[!NOTE]
|
||||
>
|
||||
> - Ketesa does not work with other homeserver implementations than Synapse due to API's incompatibility.
|
||||
> - The latest version of Ketesa is hosted by [etke.cc](https://etke.cc/) at [admin.etke.cc](https://admin.etke.cc/). If you only need this service occasionally and trust giving your admin credentials to a 3rd party Single Page Application, you can consider using it from there and avoiding the (small) overhead of self-hosting.
|
||||
> - The latest version of Ketesa is hosted by [etke.cc](https://etke.cc/) at [cloud.ketesa.app](https://cloud.ketesa.app/). If you only need this service occasionally and trust giving your admin credentials to a 3rd party Single Page Application, you can consider using it from there and avoiding the (small) overhead of self-hosting.
|
||||
> - This playbook also supports an alternative management UI in the shape of [Element Admin](./configuring-playbook-element-admin.md). Please note that it's currently less feature-rich than Ketesa and requires [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md).
|
||||
|
||||
## Adjusting DNS records (optional)
|
||||
|
||||
@@ -0,0 +1,179 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2026 Chiu Ki Sit
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
|
||||
# Configuring Synology DSM
|
||||
|
||||
This document is a guide for preparing Synology DSM for the installation of the [Matrix Docker Ansible Deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy) project.
|
||||
|
||||
> **Note:** Synology DSM is a community-supported platform. It is not officially tested or maintained by the project maintainers. Use at your own discretion.
|
||||
|
||||
**Intended audience:** Users already familiar with DSM, SSH, and this Ansible project.
|
||||
|
||||
## Assumptions
|
||||
|
||||
- DSM version 7 or higher
|
||||
- `Volume1` is used as the default Docker storage location
|
||||
- You are using DSM's built-in reverse proxy for handling HTTPS
|
||||
|
||||
## How Synology Support Works
|
||||
|
||||
The playbook automatically detects Synology DSM by checking for `/etc/synoinfo.conf`. When detected, it:
|
||||
|
||||
- Uses `synouser` and `synogroup` (DSM-native tools) instead of standard Linux user management
|
||||
- Constrains the Python `requests` package to a version compatible with the Docker SDK
|
||||
- Ensures `/volume1` has shared mount propagation so container bind mounts work correctly
|
||||
- Deploys a `matrix-synology-boot-fix` service that runs on every boot after Docker is ready
|
||||
|
||||
You can override auto-detection by setting `matrix_base_host_is_synology: true` or `false` in your `vars.yml`.
|
||||
|
||||
### Matrix Service Account
|
||||
|
||||
The playbook creates a `matrix` system account using Synology's `synouser` tool. The account is secured as follows:
|
||||
|
||||
- **Expired** (`expired=1`) — the account cannot be used to log in to DSM or any application
|
||||
|
||||
You must set a password for this account via `matrix_synology_user_password` in your `vars.yml` (see [vars.yml Configuration](#varsyml-configuration)). The password cannot be used to log in because the account is expired, but a non-empty password is required as an additional security layer.
|
||||
|
||||
> If you pre-create the `matrix` user manually before running the playbook, the playbook will not modify the existing account's settings — you are responsible for securing it.
|
||||
|
||||
### Boot-fix Service
|
||||
|
||||
Synology DSM has two boot-time quirks that the boot-fix service addresses automatically:
|
||||
|
||||
1. **`/volume1` shared mount propagation**
|
||||
|
||||
Docker requires `/volume1` to be mounted as shared (`mount --make-shared /volume1`) for container bind mounts with `bind-propagation=slave` to work correctly (used by matrix-synapse for its media store). On Synology, this cannot be inserted into the systemd chain before Container Manager starts — doing so causes Container Manager to detect a broken dependency and prompt for repair on every boot. The playbook applies this during setup, and the boot-fix service re-applies it on every subsequent reboot, safely outside Container Manager's dependency chain.
|
||||
|
||||
2. **Skipped services at boot**
|
||||
|
||||
Synology's systemd drops services with multi-level dependency chains from the boot activation queue (e.g. `matrix-traefik → matrix-container-socket-proxy → docker`). These services show as `inactive` or `failed` after reboot even though they are enabled. The boot-fix service scans for any enabled `matrix-*.service` in either state and starts them automatically.
|
||||
|
||||
> **If you previously configured a Task Scheduler entry** (`Control Panel > Task Scheduler`) to run `mount --make-shared /volume1` at boot-up, you can remove it — the boot-fix service now handles this.
|
||||
|
||||
## Synology GUI Preparation
|
||||
|
||||
1. **Enable SSH**
|
||||
- `Control Panel` > `Terminal & SNMP` > `Enable SSH service`
|
||||
|
||||
2. **Enable SFTP**
|
||||
- `Control Panel` > `File Service` > `FTP` > `Enable SFTP service` with default port
|
||||
|
||||
3. **Enable User Home Directory**
|
||||
- `Control Panel` > `User & Group` > `Advanced` > `Enable user home service`
|
||||
|
||||
4. **Install Container Manager**
|
||||
- Install from `Package Center`
|
||||
|
||||
5. **Configure Reverse Proxy**
|
||||
- `Control Panel` > `Login Portal` > `Advanced` > `Reverse Proxy`
|
||||
- Create entries for each service you enable (e.g. Matrix, Element, admin page)
|
||||
- Example entry:
|
||||
- Source: `HTTPS` / `matrix.example.com` / port `443`
|
||||
- Destination: `HTTP` / `localhost` / port `81`
|
||||
|
||||
## SSH Preparation
|
||||
|
||||
### (Optional but Recommended) Enable SSH Key Authentication
|
||||
|
||||
Configure key-based SSH login to avoid password prompts during Ansible runs.
|
||||
|
||||
### Set Up the Ansible Environment
|
||||
|
||||
Create a project folder and Python virtual environment on the DSM host:
|
||||
|
||||
```shell
|
||||
mkdir ~/path/to/your/project/folder
|
||||
cd ~/path/to/your/project/folder
|
||||
|
||||
python3 -m venv ./myenv
|
||||
# (optional) activate python virtual environment
|
||||
# source ./myenv/bin/activate
|
||||
```
|
||||
|
||||
## Inventory Configuration
|
||||
|
||||
In your `inventory/hosts` file, set the Python interpreter to your virtual environment:
|
||||
|
||||
```ini
|
||||
# SSH key authentication with empty passphrase example
|
||||
matrix.example.com ansible_host=<your-dsm-ip> ansible_ssh_user=<dsm-ssh-user> become=true become_user=root ansible_python_interpreter=/volume1/homes/path/to/your/project/folder/myenv/bin/python ansible_sudo_pass='your-password'
|
||||
```
|
||||
|
||||
## vars.yml Configuration
|
||||
|
||||
Add the following Synology-specific variables to your `vars.yml`:
|
||||
|
||||
```yaml
|
||||
# Synology-specific settings
|
||||
|
||||
# Controls Synology DSM-specific handling. `null` means autodetect (via /etc/synoinfo.conf).
|
||||
# Set to `true`/`false` to force.
|
||||
# matrix_base_host_is_synology: true
|
||||
|
||||
# Password for the Matrix service account created by the playbook.
|
||||
# The account is created as expired so this password cannot be used to log in.
|
||||
matrix_synology_user_password: "your-strong-password"
|
||||
|
||||
# User and group that will be created automatically by the playbook
|
||||
matrix_user_name: "matrix"
|
||||
matrix_group_name: "matrix"
|
||||
|
||||
# Data path on your Synology volume
|
||||
matrix_base_data_path: "/volume1/docker/matrix"
|
||||
|
||||
# Use Synology Container Manager's Docker daemon instead of installing Docker
|
||||
matrix_playbook_docker_installation_enabled: false
|
||||
devture_systemd_docker_base_host_command_docker: "/var/packages/ContainerManager/target/usr/bin/docker"
|
||||
devture_systemd_docker_base_docker_service_name: "pkg-ContainerManager-dockerd.service"
|
||||
|
||||
# Use Synology's NTP service
|
||||
devture_timesync_ntpd_service: "chronyd"
|
||||
|
||||
# Reverse proxy settings — use HTTPS at the DSM reverse proxy level
|
||||
matrix_playbook_ssl_enabled: true
|
||||
traefik_config_entrypoint_web_secure_enabled: false
|
||||
|
||||
# Bind to localhost only — DSM reverse proxy handles public traffic
|
||||
traefik_container_web_host_bind_port: '127.0.0.1:81'
|
||||
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_host_bind_port: '127.0.0.1:8449'
|
||||
|
||||
# Trust X-Forwarded-* headers from the local reverse proxy
|
||||
traefik_config_entrypoint_web_forwardedHeaders_insecure: true
|
||||
|
||||
matrix_playbook_public_matrix_federation_api_traefik_entrypoint_config_custom:
|
||||
forwardedHeaders:
|
||||
insecure: true
|
||||
```
|
||||
|
||||
## Running the Playbook
|
||||
|
||||
```shell
|
||||
# Full setup
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all
|
||||
|
||||
# start
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=install-all,start
|
||||
|
||||
# Stop all services
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=stop
|
||||
|
||||
# Apply config changes (always include start to restart running containers)
|
||||
ansible-playbook -i inventory/hosts setup.yml --tags=stop,setup-all,start
|
||||
```
|
||||
|
||||
> **Important:** Always include `stop` before `setup-all,start` when changing configuration. Running `setup-all` alone does not restart already-running containers.
|
||||
|
||||
## Creating Matrix Users
|
||||
|
||||
After the services are running, create your first Matrix user:
|
||||
|
||||
```shell
|
||||
# option 1:
|
||||
sudo docker exec -it matrix-synapse register_new_matrix_user http://localhost:8008 -c /data/homeserver.yaml -u your_username -p your_password
|
||||
|
||||
# option 2:
|
||||
ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=your_username password=your_password admin=yes|no' --tags=register-user
|
||||
```
|
||||
@@ -89,12 +89,14 @@ Web clients for Matrix that you can host on your own domains.
|
||||
|
||||
- [Setting up Cinny](configuring-playbook-client-cinny.md), if you've enabled [Cinny](https://github.com/ajbura/cinny), a web client focusing primarily on simple, elegant and secure interface
|
||||
|
||||
- [Setting up Sable](configuring-playbook-client-sable.md), if you've enabled [Sable](https://github.com/7w1/sable), a web client focusing primarily on simple, elegant and secure interface
|
||||
- [Setting up Sable](configuring-playbook-client-sable.md), if you've enabled [Sable](https://github.com/SableClient/Sable), a web client focusing primarily on simple, elegant and secure interface
|
||||
|
||||
- [Setting up SchildiChat Web](configuring-playbook-client-schildichat-web.md), if you've enabled [SchildiChat Web](https://schildi.chat/), a web client based on [Element Web](https://element.io/) with some extras and tweaks
|
||||
|
||||
- [Setting up FluffyChat Web](configuring-playbook-client-fluffychat-web.md), if you've enabled [FluffyChat Web](https://github.com/krille-chan/fluffychat), a cute cross-platform messenger (web, iOS, Android) for Matrix written in [Flutter](https://flutter.dev/)
|
||||
|
||||
- [Setting up Commet](configuring-playbook-client-commet.md), if you've enabled [Commet](https://github.com/commetchat/commet), a Matrix web client
|
||||
|
||||
|
||||
### Authentication and user-related
|
||||
|
||||
@@ -144,6 +146,8 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
|
||||
- [Setting up Mautrix Google Messages bridging](configuring-playbook-bridge-mautrix-gmessages.md)
|
||||
|
||||
- [Setting up Mautrix Google Voice bridging](configuring-playbook-bridge-mautrix-gvoice.md)
|
||||
|
||||
- [Setting up Mautrix Whatsapp bridging](configuring-playbook-bridge-mautrix-whatsapp.md)
|
||||
|
||||
- [Setting up Instagram bridging via Mautrix Meta](configuring-playbook-bridge-mautrix-meta-instagram.md)
|
||||
@@ -158,12 +162,12 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
|
||||
- [Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage](configuring-playbook-bridge-mautrix-wsproxy.md)
|
||||
|
||||
- [Setting up RustPush (iMessage) bridging](configuring-playbook-bridge-rustpush.md)
|
||||
|
||||
- [Setting up Appservice IRC bridging](configuring-playbook-bridge-appservice-irc.md)
|
||||
|
||||
- [Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md)
|
||||
|
||||
- [Setting up Appservice Kakaotalk bridging](configuring-playbook-bridge-appservice-kakaotalk.md)
|
||||
|
||||
- [Setting up Beeper LinkedIn bridging](configuring-playbook-bridge-beeper-linkedin.md)
|
||||
|
||||
- [Setting up matrix-hookshot](configuring-playbook-bridge-hookshot.md) — a bridge between Matrix and multiple project management services, such as [GitHub](https://github.com), [GitLab](https://about.gitlab.com) and [JIRA](https://www.atlassian.com/software/jira).
|
||||
@@ -188,12 +192,10 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
|
||||
Bots provide various additional functionality to your installation.
|
||||
|
||||
- [Setting up baibot](configuring-playbook-bot-baibot.md) — a bot through which you can talk to various [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) services ([OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) and [others](https://github.com/etkecc/baibot/blob/main/docs/providers.md))
|
||||
- [Setting up baibot](configuring-playbook-bot-baibot.md) — a bot through which you can talk to various [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) services (the privacy-first [Venice](configuring-playbook-bot-baibot.md#venice) we recommend, [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/), and [others](https://github.com/etkecc/baibot/blob/main/docs/providers.md))
|
||||
|
||||
- [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) — a bot to remind you about stuff
|
||||
|
||||
- [Setting up matrix-registration-bot](configuring-playbook-bot-matrix-registration-bot.md) — a bot to create and manage registration tokens to invite users
|
||||
|
||||
- [Setting up maubot](configuring-playbook-bot-maubot.md) — a plugin-based Matrix bot system
|
||||
|
||||
- [Setting up Honoroit](configuring-playbook-bot-honoroit.md) — a helpdesk bot
|
||||
@@ -261,6 +263,8 @@ Various services that don't fit any other categories.
|
||||
|
||||
- [Setting up the Sliding Sync proxy](configuring-playbook-sliding-sync-proxy.md) for clients which require Sliding Sync support (like old Element X versions, before it got switched to Simplified Sliding Sync)
|
||||
|
||||
- [Setting up Appservice Kakaotalk bridging](configuring-playbook-bridge-appservice-kakaotalk.md) (removed; the upstream repository has become unreachable and the component could only be installed by self-building it)
|
||||
|
||||
- [Setting up Appservice Slack bridging](configuring-playbook-bridge-appservice-slack.md) (removed; this component has been discontinued)
|
||||
|
||||
- [Setting up Appservice Webhooks bridging](configuring-playbook-bridge-appservice-webhooks.md) (deprecated; the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be [installed using this playbook](configuring-playbook-bridge-hookshot.md))
|
||||
@@ -281,6 +285,8 @@ Various services that don't fit any other categories.
|
||||
|
||||
- [Setting up matrix-registration](configuring-playbook-matrix-registration.md) (removed; this component has been unmaintained)
|
||||
|
||||
- [Setting up matrix-registration-bot](configuring-playbook-bot-matrix-registration-bot.md) (removed; this component has been unmaintained)
|
||||
|
||||
- [Setting up Mautrix Facebook bridging](configuring-playbook-bridge-mautrix-facebook.md) (deprecated in favor of the Messenger/Instagram bridge with [mautrix-meta-messenger](configuring-playbook-bridge-mautrix-meta-messenger.md))
|
||||
|
||||
- [Setting up Mautrix Instagram bridging](configuring-playbook-bridge-mautrix-instagram.md) (deprecated in favor of the Messenger/Instagram bridge with [mautrix-meta-instagram](configuring-playbook-bridge-mautrix-meta-instagram.md))
|
||||
|
||||
@@ -112,7 +112,9 @@ This option is less fragile and generally better.
|
||||
|
||||
On the base domain's server (e.g. `example.com`), you can set up reverse-proxying (or simply a 302 redirect), so that any access for the `/.well-known/matrix` location prefix is forwarded to the Matrix domain's server (e.g. `matrix.example.com`).
|
||||
|
||||
With this method, you **don't need** to add special HTTP headers for [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) reasons (like `Access-Control-Allow-Origin`), because your Matrix server (where requests ultimately go) will be configured by this playbook correctly.
|
||||
With reverse-proxying, you **don't need** to add special HTTP headers for [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) reasons (like `Access-Control-Allow-Origin`), because your Matrix server (where requests ultimately go) will be configured by this playbook correctly.
|
||||
|
||||
If you use a 302 redirect instead, be aware that browsers apply CORS checks to every response in the redirect chain, so the redirect response itself must also carry an `Access-Control-Allow-Origin: *` header. Otherwise, web-based Matrix clients (like Element Web) may fail to work even though the final destination sets the header correctly.
|
||||
|
||||
**For nginx**, it would be something like this:
|
||||
|
||||
@@ -155,6 +157,23 @@ example.com {
|
||||
}
|
||||
```
|
||||
|
||||
**Note**: Caddy does not process directives in the order they appear in the Caddyfile, but according to its own [directive order](https://caddyserver.com/docs/caddyfile/directives#directive-order). Notably, `redir` is evaluated before `reverse_proxy`, so a `redir` elsewhere in the same site block (a common way to send the base domain to `www.example.com` or to another site) takes precedence and breaks the well-known reverse-proxying. In such cases, wrap the directives in [`handle`](https://caddyserver.com/docs/caddyfile/directives/handle) blocks to enforce the intended priority:
|
||||
|
||||
```caddy
|
||||
example.com {
|
||||
handle /.well-known/matrix/* {
|
||||
reverse_proxy https://matrix.example.com {
|
||||
header_up Host {upstream_hostport}
|
||||
}
|
||||
}
|
||||
|
||||
handle {
|
||||
# Everything else, e.g. a redirect to some other site
|
||||
redir https://www.example.com{uri}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**For HAProxy**, it would be something like this:
|
||||
|
||||
```haproxy
|
||||
|
||||
@@ -91,6 +91,7 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
| [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) | [mautrix/slack](https://mau.dev/mautrix/slack/container_registry) | ❌ | Bridge to [Slack](https://slack.com/) |
|
||||
| [mautrix-telegram](configuring-playbook-bridge-mautrix-telegram.md) | [mautrix/telegram](https://mau.dev/mautrix/telegram/container_registry) | ❌ | Bridge to [Telegram](https://telegram.org/) |
|
||||
| [mautrix-gmessages](configuring-playbook-bridge-mautrix-gmessages.md) | [mautrix/gmessages](https://mau.dev/mautrix/gmessages/container_registry) | ❌ | Bridge to [Google Messages](https://messages.google.com/) |
|
||||
| [mautrix-gvoice](configuring-playbook-bridge-mautrix-gvoice.md) | [mautrix/gvoice](https://mau.dev/mautrix/gvoice/container_registry) | ❌ | Bridge to [Google Voice](https://voice.google.com/) |
|
||||
| [mautrix-whatsapp](configuring-playbook-bridge-mautrix-whatsapp.md) | [mautrix/whatsapp](https://mau.dev/mautrix/whatsapp/container_registry) | ❌ | Bridge to [WhatsApp](https://www.whatsapp.com/) |
|
||||
| [mautrix-wsproxy](configuring-playbook-bridge-mautrix-wsproxy.md) | [mautrix/wsproxy](https://mau.dev/mautrix/wsproxy/container_registry) | ❌ | Bridge to Android SMS or Apple iMessage |
|
||||
| [mautrix-twitter](configuring-playbook-bridge-mautrix-twitter.md) | [mautrix/twitter](https://mau.dev/mautrix/twitter/container_registry) | ❌ | Bridge to [Twitter](https://twitter.com/) |
|
||||
@@ -99,7 +100,6 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
| [mautrix-signal](configuring-playbook-bridge-mautrix-signal.md) | [mautrix/signal](https://mau.dev/mautrix/signal/container_registry) | ❌ | Bridge to [Signal](https://www.signal.org/) |
|
||||
| [beeper-linkedin](configuring-playbook-bridge-beeper-linkedin.md) | [beeper/linkedin](https://ghcr.io/beeper/linkedin) | ❌ | Bridge to [LinkedIn](https://www.linkedin.com/) |
|
||||
| [matrix-appservice-irc](configuring-playbook-bridge-appservice-irc.md) | [matrixdotorg/matrix-appservice-irc](https://hub.docker.com/r/matrixdotorg/matrix-appservice-irc) | ❌ | Bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat) |
|
||||
| [matrix-appservice-kakaotalk](configuring-playbook-bridge-appservice-kakaotalk.md) | Self-building | ❌ | Bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) |
|
||||
| [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md) | [matrix-org/matrix-appservice-discord](https://ghcr.io/matrix-org/matrix-appservice-discord) | ❌ | Bridge to [Discord](https://discordapp.com/) |
|
||||
| [matrix-hookshot](configuring-playbook-bridge-hookshot.md) | [halfshot/matrix-hookshot](https://hub.docker.com/r/halfshot/matrix-hookshot) | ❌ | Bridge for generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular |
|
||||
| [matrix-sms-bridge](configuring-playbook-bridge-matrix-bridge-sms.md) | [folivonet/matrix-sms-bridge](https://hub.docker.com/repository/docker/folivonet/matrix-sms-bridge) | ❌ | Bridge to SMS |
|
||||
@@ -107,6 +107,7 @@ Bridges can be used to connect your Matrix installation with third-party communi
|
||||
| [Heisenbridge](configuring-playbook-bridge-heisenbridge.md) | [hif1/heisenbridge](https://hub.docker.com/r/hif1/heisenbridge) | ❌ | Bouncer-style bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat) |
|
||||
| [mx-puppet-groupme](configuring-playbook-bridge-mx-puppet-groupme.md) | [xangelix/mx-puppet-groupme](https://hub.docker.com/r/xangelix/mx-puppet-groupme) | ❌ | Bridge to [GroupMe](https://groupme.com/) |
|
||||
| [matrix-steam-bridge](configuring-playbook-bridge-steam.md) | [jasonlaguidice/matrix-steam-bridge](https://github.com/jasonlaguidice/matrix-steam-bridge/pkgs/container/matrix-steam-bridge) | ❌ | Bridge to [Steam](https://steampowered.com/) |
|
||||
| [matrix-rustpush-bridge](configuring-playbook-bridge-rustpush.md) | [jasonlaguidice/imessage](https://github.com/jasonlaguidice/imessage/pkgs/container/imessage) | ❌ | Bridge to [iMessage](https://support.apple.com/messages) via Apple Push Notification service |
|
||||
| [mx-puppet-steam](configuring-playbook-bridge-mx-puppet-steam.md) | [icewind1991/mx-puppet-steam](https://hub.docker.com/r/icewind1991/mx-puppet-steam) | ❌ | Bridge to [Steam](https://steamapp.com/) |
|
||||
| [Postmoogle](configuring-playbook-bridge-postmoogle.md) | [etke.cc/postmoogle](https://github.com/etkecc/postmoogle/container_registry) | ❌ | Email to Matrix bridge |
|
||||
|
||||
@@ -118,7 +119,6 @@ Bots provide various additional functionality to your installation.
|
||||
| ------- | --------------- | -------- | ----------- |
|
||||
| [baibot](configuring-playbook-bot-baibot.md) | [etke.cc/baibot](https://ghcr.io/etkecc/baibot) | ❌ | Bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you |
|
||||
| [matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) | [anoa/matrix-reminder-bot](https://hub.docker.com/r/anoa/matrix-reminder-bot) | ❌ | Bot for scheduling one-off & recurring reminders and alarms |
|
||||
| [matrix-registration-bot](configuring-playbook-bot-matrix-registration-bot.md) | [moanos/matrix-registration-bot](https://hub.docker.com/r/moanos/matrix-registration-bot/) | ❌ | Bot for invitations by creating and managing registration tokens |
|
||||
| [maubot](configuring-playbook-bot-maubot.md) | [dock.mau.dev/maubot/maubot](https://mau.dev/maubot/maubot/container_registry) | ❌ | Plugin-based Matrix bot system |
|
||||
| [Honoroit](configuring-playbook-bot-honoroit.md) | [etke.cc/honoroit](https://github.com/etkecc/honoroit/container_registry) | ❌ | Helpdesk bot |
|
||||
| [Mjolnir](configuring-playbook-bot-mjolnir.md) | [matrixdotorg/mjolnir](https://hub.docker.com/r/matrixdotorg/mjolnir) | ❌ | Moderation tool for Matrix |
|
||||
@@ -179,6 +179,7 @@ The list of the deprecated or unmaintained services is available [here](configur
|
||||
| [matrix-chatgpt-bot](configuring-playbook-bot-chatgpt.md) | [matrixgpt/matrix-chatgpt-bot](https://ghcr.io/matrixgpt/matrix-chatgpt-bot) | ❌ | Accessing ChatGPT via your favourite Matrix client |
|
||||
| [matrix-ldap-registration-proxy](configuring-playbook-matrix-ldap-registration-proxy.md) | [activism.international/matrix_ldap_registration_proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy/container_registry) | ❌ | Proxy that handles Matrix registration requests and forwards them to LDAP |
|
||||
| [matrix-registration](configuring-playbook-matrix-registration.md) | [zeratax/matrix-registration](https://hub.docker.com/r/devture/zeratax-matrix-registration/) | ❌ | Simple python application to have a token based Matrix registration |
|
||||
| [matrix-registration-bot](configuring-playbook-bot-matrix-registration-bot.md) | [moanos/matrix-registration-bot](https://hub.docker.com/r/moanos/matrix-registration-bot/) | ❌ | Bot for invitations by creating and managing registration tokens |
|
||||
| [mautrix-facebook](configuring-playbook-bridge-mautrix-facebook.md) | [mautrix/facebook](https://mau.dev/mautrix/facebook/container_registry) | ❌ | Bridge to [Facebook](https://facebook.com/) |
|
||||
| [mautrix-instagram](configuring-playbook-bridge-mautrix-instagram.md) | [mautrix/instagram](https://mau.dev/mautrix/instagram/container_registry) | ❌ | Bridge to [Instagram](https://instagram.com/) |
|
||||
| [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) | [mx-puppet/discord/mx-puppet-discord](https://gitlab.com/mx-puppet/discord/mx-puppet-discord/container_registry) | ❌ | Bridge to [Discord](https://discordapp.com/) |
|
||||
|
||||
@@ -456,6 +456,12 @@ If it is correctly specified, look Traefik's logs (`journalctl -fu matrix-traefi
|
||||
|
||||
## Miscellaneous
|
||||
|
||||
### The role to manage the service which I deploy has been removed from the playbook. Does this mean that the service can no longer be used on my server?
|
||||
|
||||
Not necessarily. Removing the role from the playbook does not always mean that the service has been deprecated by the upstream developers, so as long as the resource such as the Docker image is available, you should be able to keep running it by reverting the specific commit which has removed the role. This essentially means that you will need to maintain your own version of the playbook.
|
||||
|
||||
Please keep in mind that you will occasionally need to fix code conflicts if any.
|
||||
|
||||
### I would like to see this favorite service of mine integrated and become available on my Matrix server. How can I request it?
|
||||
|
||||
You can freely create an issue for feature request on the repository at GitHub [here](https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/new/choose). Note this is a community project with no financial backing, and there is not assurance that your request would be eventually picked up by others and the requested feature would become available. The easiest way to get a feature into this project is to just develop it yourself.
|
||||
|
||||
@@ -23,7 +23,7 @@ Both methods have their place and will continue to do so. You only need to use j
|
||||
|
||||
For simplicity reasons, this playbook recommends you to set up server delegation via a `/.well-known/matrix/server` file. However, that method may have some downsides that are not to your liking. Hence this guide about alternative ways to set up Server Delegation.
|
||||
|
||||
**Note**: as an alternative, it is possible to install the server such that it uses only the `matrix.example.com` domain (instead of identifying as the shorter base domain — `example.com`). This should be helpful if you are not in control of anything on the base domain (`example.com`). In this case, you would not need to configure server delegation, but you would need to add other configuration. For more information, see [How do I install on matrix.example.com without involving the base domain?](faq.md#how-do-i-install-on-matrix-example-com-without-involving-the-base-domain) on our FAQ.
|
||||
**Note**: as an alternative, it is possible to install the server such that it uses only the `matrix.example.com` domain (instead of identifying as the shorter base domain — `example.com`). This should be helpful if you are not in control of anything on the base domain (`example.com`). In this case, you would not need to configure server delegation, but you would need to add other configuration. For more information, see [How do I install on matrix.example.com without involving the base domain?](faq.md#how-do-i-install-on-matrixexamplecom-without-involving-the-base-domain) on our FAQ.
|
||||
|
||||
## Server Delegation via a well-known file
|
||||
|
||||
|
||||
@@ -49,8 +49,8 @@ This is because the Matrix specification expects the federation endpoint to be s
|
||||
```yaml
|
||||
# To let Traefik know which domains' certificates to serve
|
||||
matrix_synapse_container_labels_additional_labels: |
|
||||
traefik.http.routers.matrix-synapse-federation-api.tls.domains.main="example.com"
|
||||
traefik.http.routers.matrix-synapse-federation-api.tls.domains.sans="*.example.com"
|
||||
traefik.http.routers.matrix-synapse-public-federation-api.tls.domains.main="example.com"
|
||||
traefik.http.routers.matrix-synapse-public-federation-api.tls.domains.sans="*.example.com"
|
||||
```
|
||||
|
||||
### Configure the DNS-01 challenge for let's encrypt
|
||||
@@ -137,8 +137,8 @@ matrix_synapse_container_labels_public_federation_api_traefik_rule: PathPrefix(`
|
||||
|
||||
# To let Traefik know which domains' certificates to serve
|
||||
matrix_synapse_container_labels_additional_labels: |
|
||||
traefik.http.routers.matrix-synapse-federation-api.tls.domains.main="example.com"
|
||||
traefik.http.routers.matrix-synapse-federation-api.tls.domains.sans="*.example.com"
|
||||
traefik.http.routers.matrix-synapse-public-federation-api.tls.domains.main="example.com"
|
||||
traefik.http.routers.matrix-synapse-public-federation-api.tls.domains.sans="*.example.com"
|
||||
|
||||
# Add a new ACME configuration without having to disable the default one, since it would have a wide range of side effects
|
||||
traefik_configuration_extension_yaml: |
|
||||
|
||||
@@ -25,6 +25,11 @@ The migration might be a good moment, to "reset" a not properly working bridge.
|
||||
|
||||
Before doing the actual import, **you need to upload your Postgres dump file to the server** (any path is okay).
|
||||
|
||||
> [!WARNING]
|
||||
> Do not import into a database that already contains tables (e.g. one that a service has already initialized and used). As the [official Synapse backup guide](https://element-hq.github.io/synapse/latest/usage/administration/backups.html) puts it: at best this will error, at worst it will lead to subtle database inconsistencies. Import into an empty (freshly created) database instead.
|
||||
|
||||
**Note for Synapse users restoring an older backup**: if the server kept running (and users kept chatting) after the backup you are restoring was made, truncate the `e2e_one_time_keys_json` table after importing and before starting Synapse. Restoring an older backup can otherwise cause already-used one-time keys to be re-issued, leading to message decryption errors for your users. You can do this by [getting a database terminal](maintenance-postgres.md#getting-a-database-terminal), connecting to the Synapse database (`\c synapse`) and running `TRUNCATE e2e_one_time_keys_json;`. Clients will generate and upload fresh one-time keys automatically.
|
||||
|
||||
## Importing
|
||||
|
||||
To import, run this command (make sure to replace `SERVER_PATH_TO_POSTGRES_DUMP_FILE` with a file path on your server):
|
||||
|
||||
@@ -13,6 +13,8 @@ You can manually import your `media_store` files from a previous installation of
|
||||
|
||||
Before doing the actual data restore, **you need to upload your media store directory to the server** (any path is okay).
|
||||
|
||||
You also need the [rsync](https://rsync.samba.org/) utility installed **on the server**, as the import performs a server-side `rsync` synchronization. The playbook does not install it for you. On most distributions, it is available as a package called `rsync`.
|
||||
|
||||
If you are [storing Matrix media files on Amazon S3](configuring-playbook-s3.md) (optional), restoring with this tool is not possible right now.
|
||||
|
||||
As an alternative, you can perform a manual restore using the [AWS CLI tool](https://aws.amazon.com/cli/) (e.g. `aws s3 sync /path/to/server/media_store/. s3://name-of-bucket/`)
|
||||
|
||||
+11
-3
@@ -1,13 +1,13 @@
|
||||
<!--
|
||||
SPDX-FileCopyrightText: 2018 - 2023 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2018 - 2024 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2018 Aaron Raimist
|
||||
SPDX-FileCopyrightText: 2018-2023 Slavi Pantaleev
|
||||
SPDX-FileCopyrightText: 2018-2024 MDAD project contributors
|
||||
SPDX-FileCopyrightText: 2019 Edgars Voroboks
|
||||
SPDX-FileCopyrightText: 2019 Michael Haak
|
||||
SPDX-FileCopyrightText: 2020 Kevin Lanni
|
||||
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara
|
||||
SPDX-FileCopyrightText: 2024 Mitja Jež
|
||||
SPDX-FileCopyrightText: 2024 Nikita Chernyi
|
||||
SPDX-FileCopyrightText: 2024-2026 Suguru Hirahara
|
||||
|
||||
SPDX-License-Identifier: AGPL-3.0-or-later
|
||||
-->
|
||||
@@ -41,6 +41,8 @@ If you **don't** use SSH keys for authentication, but rather a regular password,
|
||||
|
||||
If you **do** use SSH keys for authentication, **and** use a non-root user to *become* root (sudo), you may need to add `-K` (`--ask-become-pass`) to all Ansible commands.
|
||||
|
||||
Instead of typing the sudo password on each run (`-K`) or storing it in plain text in the inventory hosts file, you can also pull it from the [pass](https://www.passwordstore.org/) password manager by adding `ansible_become_password='{{ lookup("community.general.passwordstore", "path/to/password") }}'` to your host line. See the [passwordstore lookup documentation](https://docs.ansible.com/ansible/latest/collections/community/general/passwordstore_lookup.html) for more details.
|
||||
|
||||
There 2 ways to start the installation process — depending on whether you're [Installing a brand new server (without importing data)](#installing-a-brand-new-server-without-importing-data) or [Installing a server into which you'll import old data](#installing-a-server-into-which-youll-import-old-data).
|
||||
|
||||
**Note**: if you are migrating from an old server to a new one, take a look at [this guide](maintenance-migrating.md) instead. This is an easier and more straightforward way than installing a server and importing old data into it.
|
||||
@@ -150,6 +152,12 @@ After completing the installation, you can:
|
||||
* or come say Hi in our support room — [#matrix-docker-ansible-deploy:devture.com](https://matrix.to/#/#matrix-docker-ansible-deploy:devture.com). You might learn something or get to help someone else new to Matrix hosting.
|
||||
- or help make this playbook better by contributing (code, documentation, or [coffee/beer](https://liberapay.com/s.pantaleev/donate))
|
||||
|
||||
### Installing native Matrix clients on your computer
|
||||
|
||||
As the playbook's aim is to help you to install and manage Matrix services on your server, if you are looking for dedicated native Matrix clients which run on your computer, you need to install ones by yourself. There is a convenient list which introduces known Matrix clients on this page: <https://matrix.org/ecosystem/clients/>
|
||||
|
||||
If you feel overwhelmed by the variety and the number of the available clients, you might want to install [**Komai**](https://github.com/etkecc/komai), a desktop-first Matrix chat application maintained by the team behind the playbook. It is stable, and just works without quirks!
|
||||
|
||||
### ⚠️ Keep the playbook and services up-to-date
|
||||
|
||||
While this playbook helps you to set up Matrix services and maintain them, it will **not** automatically run the maintenance task for you. You will need to update the playbook and re-run it **manually**.
|
||||
|
||||
@@ -76,6 +76,8 @@ If you are using an [external Postgres server](configuring-playbook-external-pos
|
||||
|
||||
Restoring a backup made this way can be done by [importing it](importing-postgres.md).
|
||||
|
||||
**Note for Synapse users**: the [official Synapse backup guide](https://element-hq.github.io/synapse/latest/usage/administration/backups.html) recommends that the `e2e_one_time_keys_json` table either not be backed up, or be truncated after restoring (before Synapse is started). The full-server dump command above does include it, so if you ever restore a backup that is older than the server's current state, remember to truncate that table as described in [the importing guide](importing-postgres.md).
|
||||
|
||||
## Upgrading PostgreSQL
|
||||
|
||||
Unless you are using an [external Postgres server](configuring-playbook-external-postgres.md), this playbook initially installs Postgres for you.
|
||||
|
||||
@@ -105,6 +105,9 @@ Cache autotuning is **enabled by default** and controlled via the following vari
|
||||
|
||||
You can **learn more about cache-autotuning and the global cache factor settings** in the [Synapse's documentation on caches and associated values](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#caches-and-associated-values).
|
||||
|
||||
> [!NOTE]
|
||||
> These limits apply **per Synapse process**. If you have [workers](configuring-playbook-synapse.md#load-balancing-with-workers) enabled, the main process and every worker each apply the configured limits independently, so the theoretical aggregate cache memory usage gets multiplied by the number of processes. When running many workers on a memory-constrained server, consider setting these variables to lower, explicitly chosen values.
|
||||
|
||||
To **disable cache auto-tuning**, unset all values:
|
||||
|
||||
```yaml
|
||||
|
||||
+17
-1
@@ -89,7 +89,23 @@ To install Matrix services with this playbook, you would at least need 2 configu
|
||||
|
||||
For your convenience, we have prepared example files of them ([`vars.yml`](../examples/vars.yml) and [`hosts`](../examples/hosts)).
|
||||
|
||||
To start quickly based on these example files, go into the `matrix-docker-ansible-deploy` directory and follow the instructions below:
|
||||
To start quickly based on these example files, go into the `matrix-docker-ansible-deploy` directory and initialize your configuration, either automatically or manually.
|
||||
|
||||
To initialize it automatically (with the base domain and server address pre-filled and secrets generated for you), run:
|
||||
|
||||
- either: `just add-inventory-host example.com 1.2.3.4` (if you have the [`just`](just.md) tool)
|
||||
- or: `make add-inventory-host domain=example.com ip=1.2.3.4` (if you have the `make` program)
|
||||
|
||||
… where `example.com` is your "base domain" (not `matrix.example.com`) and `1.2.3.4` is your server's external IP address (or domain name).
|
||||
|
||||
Given a base domain of `example.com`, this creates:
|
||||
|
||||
- an entry for `matrix.example.com` (the Matrix server's default hostname: `matrix.` + your base domain) in the inventory hosts file (`inventory/hosts`)
|
||||
- a configuration file (`inventory/host_vars/matrix.example.com/vars.yml`) containing `matrix_domain: example.com` and automatically generated secrets
|
||||
|
||||
Afterward, edit these 2 files to adjust them further, as necessary. Existing configuration is never overwritten (the command refuses to run if the host is already in your inventory), so it can also be used for adding more hosts later.
|
||||
|
||||
To initialize it manually, follow the instructions below:
|
||||
|
||||
1. Create a directory to hold your configuration: `mkdir -p inventory/host_vars/matrix.example.com` where `example.com` is your "base domain"
|
||||
2. Copy the sample configuration file: `cp examples/vars.yml inventory/host_vars/matrix.example.com/vars.yml`
|
||||
|
||||
@@ -41,6 +41,7 @@ Possibly outdated list of roles where self-building the Docker image is currentl
|
||||
- `matrix-bridge-mautrix-telegram`
|
||||
- `matrix-bridge-mautrix-signal`
|
||||
- `matrix-bridge-mautrix-gmessages`
|
||||
- `matrix-bridge-mautrix-gvoice`
|
||||
- `matrix-bridge-mautrix-whatsapp`
|
||||
- `matrix-bridge-mx-puppet-steam`
|
||||
- `matrix-bot-mjolnir`
|
||||
|
||||
@@ -44,27 +44,19 @@ Custom Nginx Configuration:
|
||||
client_max_body_size 50M;
|
||||
```
|
||||
|
||||
Again, under the 'Proxy Hosts' page select `Add Proxy Host`, this time for your federation traffic. Apply the proxy's configuration like this:
|
||||
Then, under the 'Streams' page select `Add Stream`, this time for your federation traffic. Apply the configuration like this:
|
||||
|
||||
```md
|
||||
# Details
|
||||
# Matrix Federation proxy config
|
||||
Domain Names: matrix.example.com:8448
|
||||
Scheme: http
|
||||
Forward Hostname/IP: IP-ADDRESS-OF-YOUR-MATRIX
|
||||
Incoming Port: 8448
|
||||
Forward Host/IP: IP-ADDRESS-OF-YOUR-MATRIX
|
||||
Forward Port: 8449
|
||||
Protocols: TCP
|
||||
|
||||
# SSL
|
||||
# Either 'Request a new certificate' or select an existing one
|
||||
SSL Certificate: matrix.example.com or *.example.com
|
||||
Force SSL: true
|
||||
HTTP/2 Support: true
|
||||
|
||||
# Advanced
|
||||
# Allows NPM to listen on the federation port
|
||||
Custom Nginx Configuration:
|
||||
listen 8448 ssl http2;
|
||||
client_max_body_size 50M;
|
||||
```
|
||||
|
||||
Also note, NPM would need to be configured for whatever other services you are using. For example, you would need to create additional proxy hosts for `element.example.com` or `jitsi.example.com`, which would use the forwarding port `81`.
|
||||
|
||||
Generated
+24
-6
@@ -1,15 +1,31 @@
|
||||
{
|
||||
"nodes": {
|
||||
"agru-src": {
|
||||
"flake": false,
|
||||
"locked": {
|
||||
"lastModified": 1783761807,
|
||||
"narHash": "sha256-EVOf5r2oN2WpgodgTQmGJDPJVhgidIMz97hF6TgCyX8=",
|
||||
"owner": "etkecc",
|
||||
"repo": "agru",
|
||||
"rev": "9e2ca9d8fa904db04e8d34bf0e7b54287e850298",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "etkecc",
|
||||
"repo": "agru",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"flake-utils": {
|
||||
"inputs": {
|
||||
"systems": "systems"
|
||||
},
|
||||
"locked": {
|
||||
"lastModified": 1710146030,
|
||||
"narHash": "sha256-SZ5L6eA7HJ/nmkzGG7/ISclqe6oZdOZTNoesiInkXPQ=",
|
||||
"lastModified": 1731533236,
|
||||
"narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
|
||||
"owner": "numtide",
|
||||
"repo": "flake-utils",
|
||||
"rev": "b1d9ab70662946ef0850d488da1c9019f3a9752a",
|
||||
"rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
@@ -20,21 +36,23 @@
|
||||
},
|
||||
"nixpkgs": {
|
||||
"locked": {
|
||||
"lastModified": 1712578459,
|
||||
"narHash": "sha256-r+rjtYIdwV7mEqFwbvaS7dZSH+3xNW9loR3Rh9C0ifI=",
|
||||
"lastModified": 1783816212,
|
||||
"narHash": "sha256-2aZisVTVGSFEk3MYcOiWQp3zvwyzbqpktB69Rcfp150=",
|
||||
"owner": "NixOS",
|
||||
"repo": "nixpkgs",
|
||||
"rev": "b1a486be09c354e25a18689eb21425e43892e38c",
|
||||
"rev": "3b32825de172d0bc85664f495edb096b10862524",
|
||||
"type": "github"
|
||||
},
|
||||
"original": {
|
||||
"owner": "NixOS",
|
||||
"ref": "nixpkgs-unstable",
|
||||
"repo": "nixpkgs",
|
||||
"type": "github"
|
||||
}
|
||||
},
|
||||
"root": {
|
||||
"inputs": {
|
||||
"agru-src": "agru-src",
|
||||
"flake-utils": "flake-utils",
|
||||
"nixpkgs": "nixpkgs"
|
||||
}
|
||||
|
||||
@@ -1,31 +1,45 @@
|
||||
{
|
||||
inputs = {
|
||||
nixpkgs.url = "github:NixOS/nixpkgs";
|
||||
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
|
||||
flake-utils.url = "github:numtide/flake-utils";
|
||||
agru-src = {
|
||||
url = "github:etkecc/agru";
|
||||
flake = false;
|
||||
};
|
||||
};
|
||||
outputs = {
|
||||
self,
|
||||
nixpkgs,
|
||||
flake-utils,
|
||||
}:
|
||||
flake-utils.lib.eachDefaultSystem
|
||||
(
|
||||
system: let
|
||||
outputs =
|
||||
{
|
||||
self,
|
||||
nixpkgs,
|
||||
flake-utils,
|
||||
agru-src,
|
||||
}:
|
||||
flake-utils.lib.eachDefaultSystem (
|
||||
system:
|
||||
let
|
||||
pkgs = import nixpkgs {
|
||||
inherit system;
|
||||
};
|
||||
agru = pkgs.buildGo125Module {
|
||||
pname = "agru";
|
||||
version = "0.2.1";
|
||||
src = agru-src;
|
||||
vendorHash = null;
|
||||
};
|
||||
in
|
||||
with pkgs; {
|
||||
devShells.default = mkShell {
|
||||
buildInputs = [
|
||||
just
|
||||
mise
|
||||
ansible
|
||||
];
|
||||
shellHook = ''
|
||||
echo "$(ansible --version)"
|
||||
'';
|
||||
};
|
||||
}
|
||||
with pkgs;
|
||||
{
|
||||
devShells.default = mkShell {
|
||||
buildInputs = [
|
||||
just
|
||||
mise
|
||||
ansible
|
||||
agru
|
||||
];
|
||||
shellHook = ''
|
||||
echo "$(ansible --version)"
|
||||
'';
|
||||
};
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
+1043
-889
File diff suppressed because it is too large
Load Diff
@@ -1,10 +1,10 @@
|
||||
alabaster==1.0.0
|
||||
babel==2.18.0
|
||||
certifi==2026.5.20
|
||||
charset-normalizer==3.4.7
|
||||
click==8.4.1
|
||||
certifi==2026.6.17
|
||||
charset-normalizer==3.4.9
|
||||
click==8.4.2
|
||||
docutils==0.22.4
|
||||
idna==3.16
|
||||
idna==3.18
|
||||
imagesize==2.0.0
|
||||
Jinja2==3.1.6
|
||||
linkify-it-py==2.1.0
|
||||
@@ -17,8 +17,8 @@ packaging==26.2
|
||||
Pygments==2.20.0
|
||||
PyYAML==6.0.3
|
||||
requests==2.34.2
|
||||
setuptools==82.0.1
|
||||
snowballstemmer==3.1.0
|
||||
setuptools==83.0.0
|
||||
snowballstemmer==3.1.1
|
||||
Sphinx==9.1.0
|
||||
sphinx-intl==2.3.2
|
||||
sphinx-markdown-builder==0.6.10
|
||||
|
||||
+4322
-3830
File diff suppressed because it is too large
Load Diff
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-05-19 07:40+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -257,7 +257,7 @@ msgid "[Link](docs/configuring-playbook-client-cinny.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Sable](https://github.com/7w1/sable)"
|
||||
msgid "[Sable](https://github.com/SableClient/Sable)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
@@ -288,11 +288,23 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-client-fluffychat-web.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:72
|
||||
#: ../../../README.md:0
|
||||
msgid "[Commet](https://github.com/commetchat/commet)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Matrix web client"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-client-commet.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:73
|
||||
msgid "Server Components"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:74
|
||||
#: ../../../README.md:75
|
||||
msgid "Services that run on the server to make the various parts of your installation work."
|
||||
msgstr ""
|
||||
|
||||
@@ -380,11 +392,11 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-matrix-rtc.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:86
|
||||
#: ../../../README.md:87
|
||||
msgid "Authentication"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:88
|
||||
#: ../../../README.md:89
|
||||
msgid "Extend and modify how users are authenticated on your homeserver."
|
||||
msgstr ""
|
||||
|
||||
@@ -424,18 +436,6 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-ldap-auth.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) (advanced)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Proxy that handles Matrix registration requests and forwards them to LDAP"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-matrix-ldap-registration-proxy.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service)"
|
||||
msgstr ""
|
||||
@@ -556,6 +556,18 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-bridge-mautrix-gmessages.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[mautrix-gvoice](https://github.com/mautrix/gvoice)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Bridge to [Google Voice](https://voice.google.com/)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-bridge-mautrix-gvoice.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[mautrix-whatsapp](https://github.com/mautrix/whatsapp)"
|
||||
msgstr ""
|
||||
@@ -580,6 +592,18 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-bridge-mautrix-wsproxy.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[matrix-rustpush-bridge](https://github.com/jasonlaguidice/imessage)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Bridge to [iMessage](https://support.apple.com/messages) via Apple Push Notification service"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-bridge-rustpush.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[mautrix-bluesky](https://github.com/mautrix/bluesky)"
|
||||
msgstr ""
|
||||
@@ -664,18 +688,6 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-bridge-appservice-irc.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-bridge-appservice-kakaotalk.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[matrix-appservice-discord](https://github.com/matrix-org/matrix-appservice-discord)"
|
||||
msgstr ""
|
||||
@@ -796,11 +808,11 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-bridge-postmoogle.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:140
|
||||
#: ../../../README.md:141
|
||||
msgid "Bots"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:142
|
||||
#: ../../../README.md:143
|
||||
msgid "Bots provide various additional functionality to your installation."
|
||||
msgstr ""
|
||||
|
||||
@@ -828,18 +840,6 @@ msgstr ""
|
||||
msgid "[Link](docs/configuring-playbook-bot-matrix-reminder-bot.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "Bot for invitations by creating and managing registration tokens"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[Link](docs/configuring-playbook-bot-matrix-registration-bot.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../README.md:0
|
||||
msgid "[maubot](https://github.com/maubot/maubot)"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-06-29 17:11+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -133,37 +133,41 @@ msgid "[Alternative architectures](alternative-architectures.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:79
|
||||
msgid "[Container images used by the playbook](container-images.md)"
|
||||
msgid "[Configuring Synology DSM](configuring-playbook-synology.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:81
|
||||
msgid "[Obtaining an Access Token](obtaining-access-tokens.md)"
|
||||
msgid "[Container images used by the playbook](container-images.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:83
|
||||
msgid "[Playbook tags](playbook-tags.md)"
|
||||
msgid "[Obtaining an Access Token](obtaining-access-tokens.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:85
|
||||
msgid "[Registering users](registering-users.md)"
|
||||
msgid "[Playbook tags](playbook-tags.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:87
|
||||
msgid "[Running `just` commands](just.md)"
|
||||
msgid "[Registering users](registering-users.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:89
|
||||
msgid "[Self-building](self-building.md)"
|
||||
msgid "[Running `just` commands](just.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:91
|
||||
msgid "[Uninstalling](uninstalling.md)"
|
||||
msgid "[Self-building](self-building.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:93
|
||||
msgid "[Updating users passwords](updating-users-passwords.md)"
|
||||
msgid "[Uninstalling](uninstalling.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:95
|
||||
msgid "[Updating users passwords](updating-users-passwords.md)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/README.md:97
|
||||
msgid "[Using Ansible for the playbook](ansible.md)"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-05-19 07:40+0000\n"
|
||||
"POT-Creation-Date: 2026-07-12 15:37+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -101,92 +101,96 @@ msgid "You can either [run Ansible in a container on the Matrix server itself](#
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:53
|
||||
msgid "Running Ansible in a container on the Matrix server itself"
|
||||
msgid "💡 If you use [Visual Studio Code](https://code.visualstudio.com/) or [GitHub Codespaces](https://github.com/features/codespaces), the playbook also ships a [dev container](https://containers.dev/) configuration (see the `.devcontainer/` directory) based on this same Ansible Docker image, which can prepare such a containerized Ansible environment for you automatically."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:55
|
||||
msgid "To run Ansible in a (Docker) container on the Matrix server itself, you need to have a working Docker installation. Docker is normally installed by the playbook, so this may be a bit of a chicken and egg problem. To solve it:"
|
||||
msgid "Running Ansible in a container on the Matrix server itself"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:57
|
||||
msgid "To run Ansible in a (Docker) container on the Matrix server itself, you need to have a working Docker installation. Docker is normally installed by the playbook, so this may be a bit of a chicken and egg problem. To solve it:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:59
|
||||
msgid "you **either** need to install Docker manually first. Follow [the upstream instructions](https://docs.docker.com/engine/install/) for your distribution and consider setting `matrix_playbook_docker_installation_enabled: false` in your `vars.yml` file, to prevent the playbook from installing Docker"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:58
|
||||
#: ../../../docs/ansible.md:60
|
||||
msgid "**or** you need to run the playbook in another way (e.g. [Running Ansible in a container on another computer (not the Matrix server)](#running-ansible-in-a-container-on-another-computer-not-the-matrix-server)) at least the first time around"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:60
|
||||
#: ../../../docs/ansible.md:62
|
||||
msgid "Once you have a working Docker installation on the server, **clone the playbook** somewhere on the server and configure it as per usual (`inventory/hosts`, `inventory/host_vars/…`, etc.), as described in [configuring the playbook](configuring-playbook.md)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:62
|
||||
#: ../../../docs/ansible.md:64
|
||||
msgid "You would then need to add `ansible_connection=community.docker.nsenter` to the host line in `inventory/hosts`. This tells Ansible to connect to the \"remote\" machine by switching Linux namespaces with [nsenter](https://man7.org/linux/man-pages/man1/nsenter.1.html), instead of using SSH."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:64
|
||||
#: ../../../docs/ansible.md:66
|
||||
msgid "Alternatively, you can leave your `inventory/hosts` as is and specify the connection type in **each** `ansible-playbook` call you do later, like this: `just install-all --connection=community.docker.nsenter` (or `ansible-playbook --connection=community.docker.nsenter …`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:66
|
||||
#: ../../../docs/ansible.md:88
|
||||
#: ../../../docs/ansible.md:68
|
||||
#: ../../../docs/ansible.md:90
|
||||
msgid "Run this from the playbook's directory:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:80
|
||||
#: ../../../docs/ansible.md:103
|
||||
msgid "Once you execute the above command, you'll be dropped into a `/work` directory inside a Docker container. The `/work` directory contains the playbook's code."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:82
|
||||
#: ../../../docs/ansible.md:105
|
||||
msgid "First, consider running `git config --global --add safe.directory /work` to [resolve directory ownership issues](#resolve-directory-ownership-issues)."
|
||||
msgid "Once you execute the above command, you'll be dropped into a `/work` directory inside a Docker container. The `/work` directory contains the playbook's code."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:84
|
||||
msgid "Finally, you can execute `just` or `ansible-playbook …` (e.g. `ansible-playbook --connection=community.docker.nsenter …`) commands as per normal now."
|
||||
#: ../../../docs/ansible.md:107
|
||||
msgid "First, consider running `git config --global --add safe.directory /work` to [resolve directory ownership issues](#resolve-directory-ownership-issues)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:86
|
||||
msgid "Finally, you can execute `just` or `ansible-playbook …` (e.g. `ansible-playbook --connection=community.docker.nsenter …`) commands as per normal now."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:88
|
||||
msgid "Running Ansible in a container on another computer (not the Matrix server)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:101
|
||||
#: ../../../docs/ansible.md:103
|
||||
msgid "The above command tries to mount an SSH key (`$HOME/.ssh/id_ed25519`) into the container (at `/root/.ssh/id_ed25519`). If your SSH key is at a different path (not in `$HOME/.ssh/id_ed25519`), adjust that part."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:107
|
||||
#: ../../../docs/ansible.md:109
|
||||
msgid "Finally, you execute `just` or `ansible-playbook …` commands as per normal now."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:109
|
||||
#: ../../../docs/ansible.md:111
|
||||
msgid "If you don't use SSH keys for authentication"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:111
|
||||
#: ../../../docs/ansible.md:113
|
||||
msgid "If you don't use SSH keys for authentication, simply remove that whole line (`--mount type=bind,src$HOME/.ssh/id_ed25519,dst=/root/.ssh/id_ed25519,ro`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:113
|
||||
#: ../../../docs/ansible.md:115
|
||||
msgid "To authenticate at your server using a password, you need to add a package. So, when you are in the shell of the ansible docker container (the previously used `docker run -it …` command), run:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:119
|
||||
#: ../../../docs/ansible.md:121
|
||||
msgid "Then, to be asked for the password whenever running an `ansible-playbook` command add `--ask-pass` to the arguments of the command."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:121
|
||||
#: ../../../docs/ansible.md:123
|
||||
msgid "Resolve directory ownership issues"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:123
|
||||
#: ../../../docs/ansible.md:125
|
||||
msgid "Because you're `root` in the container running Ansible and this likely differs from the owner (your regular user account) of the playbook directory outside of the container, certain playbook features which use `git` locally may report warnings such as:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:125
|
||||
#: ../../../docs/ansible.md:127
|
||||
msgid "fatal: unsafe repository ('/work' is owned by someone else) To add an exception for this directory, call: git config --global --add safe.directory /work"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/ansible.md:129
|
||||
#: ../../../docs/ansible.md:131
|
||||
msgid "These errors can be resolved by making `git` trust the playbook directory by running `git config --global --add safe.directory /work`"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -33,43 +33,59 @@ msgid "The captcha mechanism used is Google's [ReCaptcha](https://www.google.com
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:18
|
||||
msgid "ReCaptcha"
|
||||
msgid "If you are using [Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md), captcha is configured there instead (it handles registration), and [Cloudflare Turnstile](https://www.cloudflare.com/application-services/products/turnstile/) is supported as well. See [Matrix Authentication Service](#matrix-authentication-service) below."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:20
|
||||
#: ../../../docs/configuring-captcha.md:46
|
||||
msgid "Getting keys"
|
||||
msgid "ReCaptcha"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:22
|
||||
#: ../../../docs/configuring-captcha.md:48
|
||||
msgid "Requires a site/secret key pair from:"
|
||||
msgid "Getting keys"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:24
|
||||
msgid "<http://www.google.com/recaptcha/admin>"
|
||||
#: ../../../docs/configuring-captcha.md:50
|
||||
msgid "Requires a site/secret key pair from:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:26
|
||||
msgid "Must be a reCAPTCHA **v2** key using the \"I'm not a robot\" Checkbox option"
|
||||
msgid "<http://www.google.com/recaptcha/admin>"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:28
|
||||
msgid "Setting ReCaptcha keys"
|
||||
msgid "Must be a reCAPTCHA **v2** key using the \"I'm not a robot\" Checkbox option"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:30
|
||||
msgid "Setting ReCaptcha keys"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:32
|
||||
msgid "Once registered as above, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:44
|
||||
#: ../../../docs/configuring-captcha.md:46
|
||||
msgid "hCaptcha"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:50
|
||||
#: ../../../docs/configuring-captcha.md:52
|
||||
msgid "<https://dashboard.hcaptcha.com/sites/new>"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:52
|
||||
#: ../../../docs/configuring-captcha.md:54
|
||||
msgid "Setting hCaptcha keys"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:67
|
||||
msgid "Matrix Authentication Service"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:69
|
||||
msgid "When [Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) is enabled, registration and other account operations are handled by it, so captcha protection is configured there (the Synapse and Dendrite settings above do not apply)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-captcha.md:71
|
||||
msgid "Matrix Authentication Service supports [ReCaptcha v2](http://www.google.com/recaptcha/admin), [Cloudflare Turnstile](https://www.cloudflare.com/application-services/products/turnstile/) and [hCaptcha](https://dashboard.hcaptcha.com/sites/new). Obtain a site/secret key pair from your chosen service, then add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-04-03 11:56+0100\n"
|
||||
"POT-Creation-Date: 2026-06-29 17:11+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -25,7 +25,7 @@ msgid "🤖 [baibot](https://github.com/etkecc/baibot) (pronounced bye-bot) is a
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:17
|
||||
msgid "It supports [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) models, as many well as other [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md)."
|
||||
msgid "It supports many [☁️ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md), including the privacy-first [Venice](#venice) we recommend, [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) models, and more."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:19
|
||||
@@ -183,290 +183,321 @@ msgid "Depending on your propensity for [GitOps](https://en.wikipedia.org/wiki/D
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:162
|
||||
msgid "Before proceeding, we recommend reading the upstream documentation on [How to choose a provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#how-to-choose-a-provider). In short, it's probably best to go with [OpenAI](#openai)."
|
||||
msgid "Before proceeding, we recommend reading the upstream documentation on [How to choose a provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#how-to-choose-a-provider) for a side-by-side of what each one can do. In short: we recommend [Venice](#venice), the most capable provider baibot supports and the only one that keeps no logs and trains on nothing. If you'd rather start with the most widely-used option, [OpenAI](#openai) is a solid, well-supported choice too."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:164
|
||||
msgid "Anthropic"
|
||||
msgid "Venice"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:166
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Anthropic provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#anthropic) with the help of the playbook's preset variables."
|
||||
msgid "[Venice](https://venice.ai/chat?ref=kpXDe6) _(ref link with a $10 bonus for you)_ is the provider we recommend. It's the most capable one baibot supports, and the only one that pairs that full feature set with real privacy: inference runs on Venice's own GPUs or on zero-data-retention partner hardware, so your prompts and replies are stored nowhere and never used for training. It serves both frontier proprietary models and the latest open-source ones."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:168
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:192
|
||||
msgid "Venice also leaves the content policy to you instead of imposing its own. Its models answer without the reflexive refusals some hosted services apply, and both text and image generation can handle adult or otherwise sensitive subjects when you need them to. Image generation ships a `safe_mode` that blurs adult content by default; you can turn it off (see the sample config). This pairs naturally with the privacy above: a bot you can speak to candidly, that keeps nothing."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:170
|
||||
msgid "Unlike the [OpenAI Compatible](#openai-compatible) provider (which can also point at Venice, but drops images and can't reach its audio or native image endpoints), this is a first-class integration that exposes Venice's full parameter set: text-generation with vision, file inputs, prompt caching and native web search, plus speech-to-text, text-to-speech, and image generation and editing."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:172
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Venice provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#venice) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:174
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:199
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:223
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:251
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:254
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:282
|
||||
msgid "Here's an example **addition** to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:184
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:187
|
||||
msgid "Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/venice`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:189
|
||||
msgid "Every Venice knob (sampling, caching, reasoning, web-search behavior, voice and image controls) has a matching `matrix_bot_baibot_config_agents_static_definitions_venice_config_*` variable. The [fully-commented sample config](https://github.com/etkecc/baibot/blob/main/docs/sample-provider-configs/venice.yml) explains every one of them."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:191
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:215
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:241
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:275
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:246
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:272
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:306
|
||||
msgid "If you'd like to use more than one model, take a look at the [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset) section below."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:186
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:193
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:217
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:243
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:277
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:248
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:274
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:308
|
||||
msgid "💡 You may also wish to use this new agent for [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:188
|
||||
msgid "Groq"
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:195
|
||||
msgid "Anthropic"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:190
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Groq provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#groq) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:213
|
||||
msgid "Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/groq`."
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:197
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Anthropic provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#anthropic) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:219
|
||||
msgid "Mistral"
|
||||
msgid "Groq"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:221
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Groq provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#groq) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:244
|
||||
msgid "Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/groq`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:250
|
||||
msgid "Mistral"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:252
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [🇫🇷 Mistral provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#mistral) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:239
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:270
|
||||
msgid "Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/mistral`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:245
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:276
|
||||
msgid "OpenAI"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:247
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:278
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [OpenAI provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openai) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:249
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:280
|
||||
msgid "The OpenAI provider is **only meant to be used with OpenAI's official API** and compatibility with other services (which do not fully adhere to the OpenAI API spec completely) is limited. **If you're targeting an OpenAI-compatible service**, use the [OpenAI Compatible](#openai-compatible) provider instead."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:273
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:304
|
||||
msgid "Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/openai`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:279
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:310
|
||||
msgid "OpenAI Compatible"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:281
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:312
|
||||
msgid "You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [OpenAI Compatible provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openai-compatible) with the help of the playbook's preset variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:283
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:314
|
||||
msgid "This provider allows you to use OpenAI-compatible API services like [OpenRouter](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openrouter), [Together AI](https://github.com/etkecc/baibot/blob/main/docs/providers.md#together-ai), etc."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:285
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:316
|
||||
msgid "Some of these popular services already have **shortcut** providers (see [supported providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md#supported-providers) leading to this one behind the scenes — this make it easier to get started."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:287
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:318
|
||||
msgid "As of this moment, the playbook does not include presets for any of these services, so you'll need to [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:289
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:320
|
||||
msgid "Configuring additional agents (without a preset)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:291
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:322
|
||||
msgid "The Ansible role may be lacking preset variables for some [☁️ provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md), or you may wish to statically-define an agent on the same provider twice (or more) with different configuration."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:293
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:324
|
||||
msgid "It's possible to inject your own agent configuration using the `matrix_bot_baibot_config_agents_static_definitions_custom` Ansible variable."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:295
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:326
|
||||
msgid "You can also define providers at runtime, by chatting with the bot, so using Ansible is not a requirement."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:297
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:328
|
||||
msgid "Below is an an **example** demonstrating **statically-defining agents via Ansible without using presets**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:336
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:367
|
||||
msgid "Because these are [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agents, they will be given a `static/` ID prefix and will be named `static/my-openai-gpt-3.5-turbo-agent` and `static/my-ollama-agent`, respectively."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:338
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:369
|
||||
msgid "💡 To figure out what to put in the `config` section, refer to the [☁️ provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md) page, which contains **sample configuration YAML for each provider**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:340
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:371
|
||||
msgid "As with any [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md), defining them means they exist. To actually make use of them, they need to be configured as handlers globally or in a specific room — see [Mixing & matching models](https://github.com/etkecc/baibot/blob/main/docs/features.md#mixing--matching-models)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:342
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:373
|
||||
msgid "💡 You may also wish to use these new agents for [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:344
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:375
|
||||
msgid "🤝 Configuring initial default handlers"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:346
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:377
|
||||
msgid "This section is only useful if you're [🤖 Configuring agents via Ansible](#-configuring-agents-via-ansible), as it lets you put these agents to use as soon as the bot starts (by adjusting the bot's **initial global configuration**)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:348
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:379
|
||||
msgid "If you're not configuring agents via Ansible, you can skip this section."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:350
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:381
|
||||
msgid "This section is only useful the first time around. **Once initially configured the global configuration cannot be managed Ansible**, but only via bot commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:352
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:383
|
||||
msgid "baibot supports [various purposes](https://github.com/etkecc/baibot/blob/main/docs/features.md):"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:354
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:385
|
||||
msgid "[💬 text-generation](https://github.com/etkecc/baibot/blob/main/docs/features.md#-text-generation): communicating with you via text"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:356
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:387
|
||||
msgid "[🦻 speech-to-text](https://github.com/etkecc/baibot/blob/main/docs/features.md#-speech-to-text): turning your voice messages into text"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:358
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:389
|
||||
msgid "[🗣️ text-to-speech](https://github.com/etkecc/baibot/blob/main/docs/features.md#-text-to-speech): turning bot or users text messages into voice messages"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:360
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:391
|
||||
msgid "[🖌️ image-generation](https://github.com/etkecc/baibot/blob/main/docs/features.md#-image-generation): generating images based on instructions"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:362
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:393
|
||||
msgid "❓ catch-all: special purposes, indicating use as a fallback (when no specific handler is configured)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:364
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:395
|
||||
msgid "[Mixing & matching models](https://github.com/etkecc/baibot/blob/main/docs/features.md#mixing--matching-models) is made possible by the bot's ability to have different [🤝 handlers](https://github.com/etkecc/baibot/blob/main/docs/configuration/handlers.md) configured for different purposes."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:366
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:397
|
||||
msgid "This configuration can be done as a global fallback, or per-room. Both of these [🛠️ configurations](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md) are managed at runtime (viat chat), but **the global configuration can have some initial defaults configured via Ansible**."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:368
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:399
|
||||
msgid "You can configure the **initial values** for these via Ansible, via the `matrix_bot_baibot_config_initial_global_config_handler_*` variables."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:370
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:401
|
||||
msgid "Example **additional** `vars.yml` configuration:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:387
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:418
|
||||
msgid "**Note**: these are initial defaults for the bot's global configuration. As such, changing any of these values subsequently has no effect on the bot's behavior. **Once initially configured the global configuration cannot be managed Ansible**, but only via bot commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:389
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:420
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:391
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:422
|
||||
msgid "There are some additional things you may wish to configure about the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:393
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:424
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:395
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:426
|
||||
msgid "`roles/custom/matrix-bot-baibot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:396
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:427
|
||||
msgid "`roles/custom/matrix-bot-baibot/templates/config.yaml.j2` for the bot's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_baibot_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:398
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:429
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:400
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:431
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:407
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:438
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:409
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:440
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account when password authentication is used."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:411
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:442
|
||||
msgid "If you're using access-token authentication, the bot account must already exist and the configured token + device ID must match that account. This mode is mainly for MAS/OIDC setups where password-based bot login is not suitable."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:413
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:444
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:415
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:446
|
||||
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:417
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:448
|
||||
msgid "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 [Ketesa](configuring-playbook-ketesa.md) to change it, and then update `matrix_bot_baibot_config_user_password` to let the bot know its new password. (This note applies to password authentication mode.)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:419
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:450
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:421
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:452
|
||||
msgid "To use the bot, invite it to any existing Matrix room (`/invite @baibot:example.com` where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:423
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:454
|
||||
msgid "If you're an allowed bot [👥 user](https://github.com/etkecc/baibot/blob/main/docs/access.md#user) (see [👥 Initial users configuration](#-initial-users-configuration)), the bot will accept your invitation and join the room."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:425
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:456
|
||||
msgid "After joining, the bot will introduce itself and show information about the [✨ features](https://github.com/etkecc/baibot/blob/main/docs/features.md) that are enabled for it."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:427
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:458
|
||||
msgid "If you've [🤖 configured one or more agents via Ansible](#-configuring-agents-via-ansible) and have [🤝 configured initial default handlers](#configuring-initial-default-handlers), the bot will immediately be able to make use of these agents for this new room. Otherwise, you will need to configure agents and/or handlers via chat commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:429
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:460
|
||||
msgid "Send `!bai help` to the bot in the room to see the available commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:431
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:462
|
||||
msgid "You can also refer to the upstream [baibot](https://github.com/etkecc/baibot) project's documentation."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:433
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:464
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:435
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:466
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-baibot`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:437
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:468
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:439
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:470
|
||||
msgid "The default logging level for this service is `info`. If you want to increase the verbosity to `debug` (or even `trace`), add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:453
|
||||
#: ../../../docs/configuring-playbook-bot-baibot.md:484
|
||||
msgid "**Alternatively**, you can use a single variable to set the logging level for all of the above (bot + all libraries):"
|
||||
msgstr ""
|
||||
|
||||
+9
-109
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-04-03 11:56+0100\n"
|
||||
"POT-Creation-Date: 2026-07-12 11:50+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,118 +16,18 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:13
|
||||
msgid "Setting up matrix-registration-bot (optional)"
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:22
|
||||
msgid "Setting up matrix-registration-bot (optional, removed)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:15
|
||||
msgid "The playbook can install and configure [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) for you."
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:24
|
||||
msgid "🪦 The playbook used to be able to install and configure [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot), but no longer includes this component, as it has been unmaintained."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:17
|
||||
msgid "The bot allows you to easily **create and manage registration tokens** aka. invitation codes. It can be used for an invitation-based server, where you invite someone by sending them a registration token (tokens look like this: `rbalQ0zkaDSRQCOp`). They can register as per normal but have to provide a valid registration token in the final step of the registration process."
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:26
|
||||
msgid "Uninstalling the component manually"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:19
|
||||
msgid "See the project's [documentation](https://github.com/moan0s/matrix-registration-bot/blob/master/README.md) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:21
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:23
|
||||
msgid "To enable the bot, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:46
|
||||
msgid "The bot account will be created automatically."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:48
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:50
|
||||
msgid "There are some additional things you may wish to configure about the bot."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:52
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:54
|
||||
msgid "`roles/custom/matrix-bot-matrix-registration-bot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:55
|
||||
msgid "`roles/custom/matrix-bot-matrix-registration-bot/templates/config.yaml.j2` for the bridge's default configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:57
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:59
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:66
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:68
|
||||
msgid "The `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:70
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:72
|
||||
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:74
|
||||
msgid "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 [Ketesa](configuring-playbook-ketesa.md) to change it, and then update `matrix_bot_matrix_registration_bot_bot_password` to let the bot know its new password."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:76
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:78
|
||||
msgid "To use the bot, start a chat with `@bot.matrix-registration-bot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:80
|
||||
msgid "Send `help` to the bot to see the available commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:82
|
||||
msgid "You can also refer to the upstream [Usage documentation](https://github.com/moan0s/matrix-registration-bot#supported-commands)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:84
|
||||
msgid "If you have any questions, or if you need help setting it up, read the [troubleshooting guide](https://github.com/moan0s/matrix-registration-bot/blob/main/docs/troubleshooting.md) or join [#matrix-registration-bot:hyteck.de](https://matrix.to/#/#matrix-registration-bot:hyteck.de)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:86
|
||||
msgid "To clean the cache (session & encryption data) after you changed the bot's username, changed the login method from access_token to password etc… you can use:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:92
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:94
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-matrix-registration-bot`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:96
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:98
|
||||
msgid "The default logging level for this component is `INFO`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
#: ../../../docs/configuring-playbook-bot-matrix-registration-bot.md:28
|
||||
msgid "If you still have matrix-registration-bot installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -73,7 +73,7 @@ msgid "`roles/custom/matrix-bridge-appservice-discord/defaults/main.yml` for som
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:47
|
||||
msgid "`roles/custom/matrix-bridge-appservice-discord/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_discord_configuration_extension_yaml` variable"
|
||||
msgid "`roles/custom/matrix-bridge-appservice-discord/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_appservice_discord_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:49
|
||||
@@ -150,7 +150,7 @@ msgid "To get started with Portal Bridging:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:101
|
||||
msgid "To invite the bot to Discord, retrieve the invite link from the `{{ matrix_appservice_discord_config_path }}/invite_link` file on the server (this defaults to `/matrix/appservice-discord/config/invite_link`). You need to peek at the file on the server via SSH, etc., because it's not available via HTTP(S)."
|
||||
msgid "To invite the bot to Discord, retrieve the invite link from the `{{ matrix_bridge_appservice_discord_config_path }}/invite_link` file on the server (this defaults to `/matrix/appservice-discord/config/invite_link`). You need to peek at the file on the server via SSH, etc., because it's not available via HTTP(S)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-discord.md:102
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -57,7 +57,7 @@ msgid "`roles/custom/matrix-bridge-appservice-irc/defaults/main.yml` for some va
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:79
|
||||
msgid "`roles/custom/matrix-bridge-appservice-irc/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_irc_configuration_extension_yaml` variable"
|
||||
msgid "`roles/custom/matrix-bridge-appservice-irc/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_appservice_irc_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-irc.md:81
|
||||
|
||||
+8
-96
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-05-19 07:40+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -17,109 +17,21 @@ msgstr ""
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:10
|
||||
msgid "Setting up Appservice Kakaotalk bridging (optional)"
|
||||
msgid "Setting up Appservice Kakaotalk bridging (optional, removed)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:12
|
||||
msgid "The playbook can install and configure [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) for you, for bridging to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG). This bridge is based on [node-kakao](https://github.com/storycraft/node-kakao) (now unmaintained) and some [mautrix-facebook](https://github.com/mautrix/facebook) code."
|
||||
msgid "🪦 The playbook used to be able to install and configure [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) (a bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG)), but no longer includes this component."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:14
|
||||
msgid "See the project's [documentation](https://src.miscworks.net/fair/matrix-appservice-kakaotalk/src/branch/master/README.md) to learn what it does and why it might be useful to you."
|
||||
msgid "The bridge could only be installed by self-building its source code, and its upstream repository has become unreachable, which makes installation impossible. The bridge was also based on the now-unmaintained [node-kakao](https://github.com/storycraft/node-kakao) library, and there have been reports that using it may get your Kakaotalk account banned."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:17
|
||||
msgid "There have been recent reports (~2022-09-16) that **using this bridge may get your account banned**."
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:16
|
||||
msgid "Uninstalling the component manually"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:19
|
||||
msgid "Prerequisite (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:21
|
||||
msgid "Enable Shared Secret Auth"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:23
|
||||
msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) for this playbook."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:25
|
||||
msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:27
|
||||
msgid "**Note**: double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:29
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:31
|
||||
msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:37
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:39
|
||||
msgid "There are some additional things you may wish to configure about the bridge."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:41
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:43
|
||||
msgid "`roles/custom/matrix-bridge-appservice-kakaotalk/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:44
|
||||
msgid "`roles/custom/matrix-bridge-appservice-kakaotalk/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_appservice_kakaotalk_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:46
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:48
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:55
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:57
|
||||
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:59
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:61
|
||||
msgid "To use the bridge, you need to start a chat with `@kakaotalkbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:63
|
||||
msgid "You then need to send `login --save EMAIL_OR_PHONE_NUMBER` to the bridge bot to enable bridging for your Kakaotalk account. The `--save` flag may be omitted, if you'd rather not save your password."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:65
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:67
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-appservice-kakaotalk`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:69
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:71
|
||||
msgid "The default logging level for this component is `WARNING`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
#: ../../../docs/configuring-playbook-bridge-appservice-kakaotalk.md:18
|
||||
msgid "If you still have matrix-appservice-kakaotalk installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -57,7 +57,7 @@ msgid "Adjusting the Heisenbridge URL (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:40
|
||||
msgid "By tweaking the `matrix_heisenbridge_hostname` and `matrix_heisenbridge_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
|
||||
msgid "By tweaking the `matrix_bridge_heisenbridge_hostname` and `matrix_bridge_heisenbridge_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-heisenbridge.md:42
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -56,95 +56,103 @@ msgstr ""
|
||||
msgid "Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file. Make sure to replace `GITHUB_PRIVATE_KEY_HERE` with the one created [above](#download-github-app-private-key)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:43
|
||||
msgid "For each of the services (GitHub, GitLab, Jira, Figma, and generic webhooks) fill in the respective variables `matrix_hookshot_service_*` listed in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) as required."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:45
|
||||
msgid "Take special note of the `matrix_hookshot_*_enabled` variables. Services that need no further configuration are enabled by default (GitLab and generic webhooks), while you must first add the required configuration and enable the others (GitHub, Jira, and Figma)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:47
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:49
|
||||
msgid "There are some additional things you may wish to configure about the bridge."
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:44
|
||||
msgid "End-to-bridge encryption also requires the homeserver to support (and have enabled) [MSC2409](https://github.com/matrix-org/matrix-spec-proposals/pull/2409) and [MSC3202](https://github.com/matrix-org/matrix-spec-proposals/pull/3202). If you are using Synapse, enable them by also adding this to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:51
|
||||
msgid "Take a look at:"
|
||||
msgid "These are experimental homeserver-wide features (as is Hookshot's encryption support itself), so enable them deliberately."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:53
|
||||
msgid "For each of the services (GitHub, GitLab, Jira, Figma, and generic webhooks) fill in the respective variables `matrix_bridge_hookshot_service_*` listed in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) as required."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:55
|
||||
msgid "Take special note of the `matrix_bridge_hookshot_*_enabled` variables. Services that need no further configuration are enabled by default (GitLab and generic webhooks), while you must first add the required configuration and enable the others (GitHub, Jira, and Figma)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:57
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:59
|
||||
msgid "There are some additional things you may wish to configure about the bridge."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:61
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:63
|
||||
msgid "`roles/custom/matrix-bridge-hookshot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:54
|
||||
msgid "`roles/custom/matrix-bridge-hookshot/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_hookshot_configuration_extension_yaml` and `matrix_hookshot_registration_extension_yaml` variables"
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:64
|
||||
msgid "`roles/custom/matrix-bridge-hookshot/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_hookshot_configuration_extension_yaml` and `matrix_bridge_hookshot_registration_extension_yaml` variables"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:56
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:66
|
||||
msgid "Refer the [official instructions](https://matrix-org.github.io/matrix-hookshot/latest/setup.html) and the comments in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) to learn what the individual options do."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:58
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:68
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:60
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:70
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:67
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:77
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-service hookshot` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:69
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:79
|
||||
msgid "`just install-service hookshot` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note `just setup-all` runs the `ensure-matrix-users-created` tag too."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:71
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:81
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:73
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:83
|
||||
msgid "To use the bridge, you need to create a room and invite the Hookshot bot (`@hookshot:example.com`) to it."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:75
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:85
|
||||
msgid "Make sure the bot is able to send state events (usually the Moderator power level in clients)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:77
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:87
|
||||
msgid "Send `!hookshot help` to the bot to see the available commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:79
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:89
|
||||
msgid "Refer to [Hookshot's documentation](https://matrix-org.github.io/matrix-hookshot/latest/usage.html) for more details about using the bridge's various features."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:81
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:91
|
||||
msgid "💡 **Note**: the different listeners are bound to certain paths which might differ from those assumed by the hookshot documentation. See [URLs for bridges setup](#urls-for-bridges-setup) below."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:83
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:93
|
||||
msgid "Reset crypto store"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:85
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:95
|
||||
msgid "Should the crypto store be corrupted, you can reset it by executing this Ansible playbook with the tag `reset-hookshot-encryption` added:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:91
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:101
|
||||
msgid "More setup documentation"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:93
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:103
|
||||
msgid "URLs for bridges setup"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:95
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:105
|
||||
msgid "Unless indicated otherwise, the following endpoints are reachable on your `matrix.` subdomain (if the feature is enabled)."
|
||||
msgstr ""
|
||||
|
||||
@@ -173,7 +181,7 @@ msgid "`/hookshot/webhooks/`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
msgid "`matrix_hookshot_webhook_endpoint`"
|
||||
msgid "`matrix_bridge_hookshot_webhook_endpoint`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
@@ -189,7 +197,7 @@ msgid "`/hookshot/webhooks/webhook`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
msgid "`matrix_hookshot_generic_endpoint`"
|
||||
msgid "`matrix_bridge_hookshot_generic_endpoint`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
@@ -205,7 +213,7 @@ msgid "`/hookshot/webhooks/oauth`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
msgid "`matrix_hookshot_github_oauth_endpoint`"
|
||||
msgid "`matrix_bridge_hookshot_github_oauth_endpoint`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
@@ -221,7 +229,7 @@ msgid "`/hookshot/webhooks/jira/oauth`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
msgid "`matrix_hookshot_jira_oauth_endpoint`"
|
||||
msgid "`matrix_bridge_hookshot_jira_oauth_endpoint`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
@@ -237,7 +245,7 @@ msgid "`/hookshot/webhooks/figma/webhook`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
msgid "`matrix_hookshot_figma_endpoint`"
|
||||
msgid "`matrix_bridge_hookshot_figma_endpoint`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
@@ -253,7 +261,7 @@ msgid "`/hookshot/_matrix/app/`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
msgid "`matrix_hookshot_appservice_endpoint`"
|
||||
msgid "`matrix_bridge_hookshot_appservice_endpoint`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
@@ -269,105 +277,105 @@ msgid "`/hookshot/widgetapi/`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
msgid "`matrix_hookshot_widgets_endpoint`"
|
||||
msgid "`matrix_bridge_hookshot_widgets_endpoint`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:0
|
||||
msgid "Widgets"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:107
|
||||
msgid "Also see the various `matrix_hookshot_container_labels_*` variables in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml), which expose URLs publicly."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:109
|
||||
msgid "The different listeners are also reachable *internally* in the docker-network via the container's name (configured by `matrix_hookshot_container_url`) and on different ports (e.g. `matrix_hookshot_appservice_port`). Read [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) in detail for more info."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:111
|
||||
msgid "Manage GitHub Private Key with aux role"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:113
|
||||
msgid "The GitHub bridge requires you to install a private key file. This can be done in multiple ways:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:115
|
||||
msgid "copy the *contents* of the downloaded file and set the variable `matrix_hookshot_github_private_key` to the contents (see example in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml))."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:116
|
||||
msgid "somehow copy the file to the path `{{ matrix_hookshot_base_path }}/{{ matrix_hookshot_github_private_key_file }}` (default: `/matrix/hookshot/private-key.pem`) on the server manually."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:117
|
||||
msgid "use the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux) to copy the file from an arbitrary path on your ansible client to the correct path on the server."
|
||||
msgid "Also see the various `matrix_bridge_hookshot_container_labels_*` variables in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml), which expose URLs publicly."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:119
|
||||
msgid "To use the `aux` role, make sure the `matrix_hookshot_github_private_key` variable is empty. Then add the following configuration to your `vars.yml` file:"
|
||||
msgid "The different listeners are also reachable *internally* in the docker-network via the container's name (configured by `matrix_bridge_hookshot_container_url`) and on different ports (e.g. `matrix_bridge_hookshot_appservice_port`). Read [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml) in detail for more info."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:130
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:121
|
||||
msgid "Manage GitHub Private Key with aux role"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:123
|
||||
msgid "The GitHub bridge requires you to install a private key file. This can be done in multiple ways:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:125
|
||||
msgid "copy the *contents* of the downloaded file and set the variable `matrix_bridge_hookshot_github_private_key` to the contents (see example in [main.yml](../roles/custom/matrix-bridge-hookshot/defaults/main.yml))."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:126
|
||||
msgid "somehow copy the file to the path `{{ matrix_bridge_hookshot_base_path }}/{{ matrix_bridge_hookshot_github_private_key_file }}` (default: `/matrix/hookshot/private-key.pem`) on the server manually."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:127
|
||||
msgid "use the [`aux` role](https://github.com/mother-of-all-self-hosting/ansible-role-aux) to copy the file from an arbitrary path on your ansible client to the correct path on the server."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:129
|
||||
msgid "To use the `aux` role, make sure the `matrix_bridge_hookshot_github_private_key` variable is empty. Then add the following configuration to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:140
|
||||
msgid "For more information, see the documentation in the [default configuration of the aux role](https://github.com/mother-of-all-self-hosting/ansible-role-aux/blob/main/defaults/main.yml)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:132
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:142
|
||||
msgid "Enable metrics"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:134
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:144
|
||||
msgid "The playbook can enable and configure the metrics of the service for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:136
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:146
|
||||
msgid "Metrics are **only enabled by default** if the builtin [Prometheus](configuring-playbook-prometheus-grafana.md) is enabled (by default, Prometheus isn't enabled). If so, metrics will automatically be collected by Prometheus and made available in Grafana. You will, however, need to set up your own Dashboard for displaying them."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:138
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:148
|
||||
msgid "To enable the metrics, add the following configuration to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:145
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:155
|
||||
msgid "**To collect metrics from an external Prometheus server**, besides enabling metrics as described above, you will also need to enable metrics exposure on `https://matrix.example.com/metrics/hookshot` by adding the following configuration to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:151
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:161
|
||||
msgid "By default metrics are exposed publicly **without** password-protection. To password-protect the metrics with dedicated credentials, add the following configuration to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:158
|
||||
msgid "To `matrix_hookshot_container_labels_metrics_middleware_basic_auth_users`, set the Basic Authentication credentials (raw `htpasswd` file content) used to protect the endpoint. See https://doc.traefik.io/traefik/middlewares/http/basicauth/#users for details about it."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:160
|
||||
msgid "**Note**: alternatively, you can use `matrix_metrics_exposure_enabled` to expose all services on this `/metrics/*` feature, and you can use `matrix_metrics_exposure_http_basic_auth_enabled` and `matrix_metrics_exposure_http_basic_auth_users` to password-protect the metrics of them. See [this section](configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) for more information."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:162
|
||||
msgid "Enable Grafana (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:164
|
||||
msgid "Probably you wish to enable Grafana along with Prometheus for generating graphs of the metrics."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:166
|
||||
msgid "To enable Grafana, see [this section](configuring-playbook-prometheus-grafana.md#adjusting-the-playbook-configuration-grafana) for instructions."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:168
|
||||
msgid "Troubleshooting"
|
||||
msgid "To `matrix_bridge_hookshot_container_labels_metrics_middleware_basic_auth_users`, set the Basic Authentication credentials (raw `htpasswd` file content) used to protect the endpoint. See https://doc.traefik.io/traefik/middlewares/http/basicauth/#users for details about it."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:170
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-hookshot`."
|
||||
msgid "**Note**: alternatively, you can use `matrix_metrics_exposure_enabled` to expose all services on this `/metrics/*` feature, and you can use `matrix_metrics_exposure_http_basic_auth_enabled` and `matrix_metrics_exposure_http_basic_auth_users` to password-protect the metrics of them. See [this section](configuring-playbook-prometheus-grafana.md#collecting-metrics-to-an-external-prometheus-server) for more information."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:172
|
||||
msgid "Increase logging verbosity"
|
||||
msgid "Enable Grafana (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:174
|
||||
msgid "Probably you wish to enable Grafana along with Prometheus for generating graphs of the metrics."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:176
|
||||
msgid "To enable Grafana, see [this section](configuring-playbook-prometheus-grafana.md#adjusting-the-playbook-configuration-grafana) for instructions."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:178
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:180
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-hookshot`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:182
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-hookshot.md:184
|
||||
msgid "The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -57,7 +57,7 @@ msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:49
|
||||
msgid "`roles/custom/matrix-bridge-sms/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_sms_bridge_configuration_extension_yaml` variable"
|
||||
msgid "`roles/custom/matrix-bridge-sms/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_sms_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-matrix-bridge-sms.md:51
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -41,11 +41,11 @@ msgid "To enable the bridge, add the following configuration to your `inventory/
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:27
|
||||
msgid "**Note**: for bridging to Meta's Messenger or Instagram, you would need to add `meta` with an underscore symbol (`_`) or hyphen (`-`) based on the context as prefix to each `SERVICENAME`; add `_` to variables (as in `matrix_mautrix_meta_messenger_configuration_extension_yaml` for example) and `-` to paths of the configuration files (as in `roles/custom/matrix-bridge-mautrix-meta-messenger/templates/config.yaml.j2`), respectively."
|
||||
msgid "**Note**: for bridging to Meta's Messenger or Instagram, you would need to add `meta` with an underscore symbol (`_`) or hyphen (`-`) based on the context as prefix to each `SERVICENAME`; add `_` to variables (as in `matrix_bridge_mautrix_meta_messenger_configuration_extension_yaml` for example) and `-` to paths of the configuration files (as in `roles/custom/matrix-bridge-mautrix-meta-messenger/templates/config.yaml.j2`), respectively."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:29
|
||||
msgid "There are some additional things you may wish to configure about the bridge before you continue. Each bridge may have additional requirements besides `_enabled: true`. For example, the mautrix-telegram bridge (our documentation page about it is [here](configuring-playbook-bridge-mautrix-telegram.md)) requires the `matrix_mautrix_telegram_api_id` and `matrix_mautrix_telegram_api_hash` variables to be defined. Refer to each bridge's individual documentation page for details about enabling bridges."
|
||||
msgid "There are some additional things you may wish to configure about the bridge before you continue. Each bridge may have additional requirements besides `_enabled: true`. For example, the mautrix-telegram bridge (our documentation page about it is [here](configuring-playbook-bridge-mautrix-telegram.md)) requires the `matrix_bridge_mautrix_telegram_api_id` and `matrix_bridge_mautrix_telegram_api_hash` variables to be defined. Refer to each bridge's individual documentation page for details about enabling bridges."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:31
|
||||
@@ -110,7 +110,7 @@ msgid "**for all bridges with relay mode support**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:95
|
||||
msgid "You can only have one `matrix_mautrix_SERVICENAME_configuration_extension_yaml` definition in `vars.yml` per bridge, so if you need multiple pieces of configuration there, just merge them like this:"
|
||||
msgid "You can only have one `matrix_bridge_mautrix_SERVICENAME_configuration_extension_yaml` definition in `vars.yml` per bridge, so if you need multiple pieces of configuration there, just merge them like this:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:109
|
||||
@@ -154,141 +154,173 @@ msgid "If you have issues with a service, and are requesting support, the higher
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:141
|
||||
msgid "Extending the configuration"
|
||||
msgid "Expose the bridge's API (for Mautrix Manager and similar tools)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:143
|
||||
msgid "There are some additional things you may wish to configure about the bridge."
|
||||
msgid "Each mautrix bridge runs an HTTP API which tools like [Mautrix Manager](https://github.com/mautrix/manager) can use to help you log into the bridge. This is especially handy for bridges where logging in manually is cumbersome (like [mautrix-gmessages](configuring-playbook-bridge-mautrix-gmessages.md))."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:145
|
||||
msgid "Take a look at:"
|
||||
msgid "By default, the playbook exposes this API publicly at `https://matrix.example.com/bridges/SERVICENAME` (for example, `https://matrix.example.com/bridges/gmessages`). Such tools authenticate to the bridge with your own Matrix access token, so you never need to share any bridge secret with them."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:147
|
||||
msgid "`roles/custom/matrix-bridge-mautrix-SERVICENAME/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgid "To make discovery easier, the playbook also serves a `/.well-known/matrix/mautrix` file which advertises all your exposed bridges. Mautrix Manager reads this file and offers your bridges automatically, so you don't need to enter their URLs by hand."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:148
|
||||
msgid "`roles/custom/matrix-bridge-mautrix-SERVICENAME/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_mautrix_SERVICENAME_configuration_extension_yaml` variable"
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:149
|
||||
msgid "This is all enabled by default. To **disable exposing the API for all bridges**, add the following configuration to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:150
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:152
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:159
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:155
|
||||
msgid "**Alternatively**, to disable it for a specific bridge:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:161
|
||||
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."
|
||||
msgid "If you run additional bridges on the same server which are not managed by this playbook and would like compatible tools to discover them as well, you can advertise their base URLs in the `/.well-known/matrix/mautrix` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:163
|
||||
msgid "Usage"
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:168
|
||||
msgid "Only list bridges hosted on (and connected to) this server here, as compatible tools will send your Matrix access token to them. For bridges on other servers, take a look at the `fi.mau.external_bridge_servers` property described in the [Mautrix Manager](https://github.com/mautrix/manager) documentation, which you can add via `matrix_static_files_file_matrix_mautrix_configuration_extension_json`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:165
|
||||
msgid "To use the bridge, you need to start a chat with `@SERVICENAMEbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:170
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:167
|
||||
msgid "For details about the next steps, refer to each bridge's individual documentation page."
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:172
|
||||
msgid "There are some additional things you may wish to configure about the bridge."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:169
|
||||
msgid "Send `help` to the bot to see the available commands."
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:174
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:171
|
||||
msgid "If you run into trouble, check the [Troubleshooting](#troubleshooting) section below."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:173
|
||||
msgid "Set up Double Puppeting (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:175
|
||||
msgid "After successfully enabling bridging, you may wish to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do)."
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:176
|
||||
msgid "`roles/custom/matrix-bridge-mautrix-SERVICENAME/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:177
|
||||
msgid "To set it up, you have 2 ways of going about it."
|
||||
msgid "`roles/custom/matrix-bridge-mautrix-SERVICENAME/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_mautrix_SERVICENAME_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:179
|
||||
msgid "Method 1: automatically, by enabling Appservice Double Puppet (recommended)"
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:181
|
||||
msgid "To set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html), you could enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook."
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:183
|
||||
msgid "Appservice Double Puppet is a homeserver appservice through which bridges (and potentially other services) can impersonate any user on the homeserver."
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:188
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:185
|
||||
msgid "To enable the Appservice Double Puppet service, add the following configuration to your `vars.yml` file:"
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:190
|
||||
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:191
|
||||
msgid "When enabled, double puppeting will automatically be enabled for all bridges that support double puppeting via the appservice method."
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:192
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:193
|
||||
msgid "This is the recommended way of setting up Double Puppeting, as it's easier to accomplish, works for all your users automatically, and has less of a chance of breaking in the future."
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:194
|
||||
msgid "To use the bridge, you need to start a chat with `@SERVICENAMEbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:195
|
||||
msgid "**Notes**:"
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:196
|
||||
msgid "For details about the next steps, refer to each bridge's individual documentation page."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:197
|
||||
msgid "Previously there were multiple different automatic double puppeting methods like one with the help of the [Shared Secret Auth password provider module](./configuring-playbook-shared-secret-auth.md), but they have been superseded by this Appservice Double Puppet method. Double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future as the older methods were completely removed in the megabridge rewrites on [the upstream project](https://docs.mau.fi/bridges/general/double-puppeting.html#automatically)."
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:198
|
||||
msgid "Send `help` to the bot to see the available commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:200
|
||||
msgid "Some bridges like [the deprecated Facebook mautrix bridge](configuring-playbook-bridge-mautrix-facebook.md) and [matrix-appservice-kakaotalk](configuring-playbook-bridge-appservice-kakaotalk.md), which is partially based on the Facebook bridge, are compatible with the Shared Secret Auth service only. These bridges automatically perform Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook."
|
||||
msgid "If you run into trouble, check the [Troubleshooting](#troubleshooting) section below."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:202
|
||||
msgid "Method 2: manually, by asking each user to provide a working access token"
|
||||
msgid "Set up Double Puppeting (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:204
|
||||
msgid "When using this method, **each user** that wishes to enable Double Puppeting needs to follow the following steps:"
|
||||
msgid "After successfully enabling bridging, you may wish to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:206
|
||||
msgid "retrieve a Matrix access token for yourself. Refer to the documentation on [how to obtain one](obtaining-access-tokens.md)."
|
||||
msgid "To set it up, you have 2 ways of going about it."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:208
|
||||
msgid "send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE`"
|
||||
msgid "Method 1: automatically, by enabling Appservice Double Puppet (recommended)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:210
|
||||
msgid "make sure you don't log out the session for which you obtained an access token some time in the future, as that would break the Double Puppeting feature"
|
||||
msgid "To set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html), you could enable the [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:212
|
||||
msgid "Troubleshooting"
|
||||
msgid "Appservice Double Puppet is a homeserver appservice through which bridges (and potentially other services) can impersonate any user on the homeserver."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:214
|
||||
msgid "To enable the Appservice Double Puppet service, add the following configuration to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:220
|
||||
msgid "When enabled, double puppeting will automatically be enabled for all bridges that support double puppeting via the appservice method."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:222
|
||||
msgid "This is the recommended way of setting up Double Puppeting, as it's easier to accomplish, works for all your users automatically, and has less of a chance of breaking in the future."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:224
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:226
|
||||
msgid "Previously there were multiple different automatic double puppeting methods like one with the help of the [Shared Secret Auth password provider module](./configuring-playbook-shared-secret-auth.md), but they have been superseded by this Appservice Double Puppet method. Double puppeting with the Shared Secret Auth works at the time of writing, but is deprecated and will stop working in the future as the older methods were completely removed in the megabridge rewrites on [the upstream project](https://docs.mau.fi/bridges/general/double-puppeting.html#automatically)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:229
|
||||
msgid "Some bridges like [the deprecated Facebook mautrix bridge](configuring-playbook-bridge-mautrix-facebook.md) are compatible with the Shared Secret Auth service only. These bridges automatically perform Double Puppeting if [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) service is configured and enabled on the server for this playbook."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:231
|
||||
msgid "Method 2: manually, by asking each user to provide a working access token"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:233
|
||||
msgid "When using this method, **each user** that wishes to enable Double Puppeting needs to follow the following steps:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:235
|
||||
msgid "retrieve a Matrix access token for yourself. Refer to the documentation on [how to obtain one](obtaining-access-tokens.md)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:237
|
||||
msgid "send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:239
|
||||
msgid "make sure you don't log out the session for which you obtained an access token some time in the future, as that would break the Double Puppeting feature"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:241
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:243
|
||||
msgid "For troubleshooting information with a specific bridge, please see the playbook documentation about it (some other document in in `docs/`) and the upstream ([mautrix](https://github.com/mautrix)) bridge documentation for that specific bridge."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:216
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:245
|
||||
msgid "If the bridge's bot doesn't accept the invite to a chat, refer [the official troubleshooting page](https://docs.mau.fi/bridges/general/troubleshooting.html) as well."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:218
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-bridges.md:247
|
||||
msgid "If you found bugs in mautrix bridges, they should be reported to the upstream project, in the corresponding mautrix repository, not to us."
|
||||
msgstr ""
|
||||
|
||||
@@ -0,0 +1,121 @@
|
||||
# SOME DESCRIPTIVE TITLE.
|
||||
# Copyright (C) 2018-2026, Slavi Pantaleev, Aine Etke, MDAD community members
|
||||
# This file is distributed under the same license as the matrix-docker-ansible-deploy package.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
||||
#
|
||||
#, fuzzy
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:8
|
||||
msgid "Setting up Mautrix Google Voice bridging (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:10
|
||||
msgid "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:12
|
||||
msgid "The playbook can install and configure [mautrix-gvoice](https://github.com/mautrix/gvoice) for you, for bridging to [Google Voice](https://voice.google.com/)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:14
|
||||
msgid "See the project's [documentation](https://docs.mau.fi/bridges/go/gvoice/index.html) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:16
|
||||
msgid "Prerequisite (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:18
|
||||
msgid "Enable Appservice Double Puppet"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:20
|
||||
msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) for this playbook."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:22
|
||||
msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:24
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:26
|
||||
msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:32
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:34
|
||||
msgid "There are some additional things you may wish to configure about the bridge."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:37
|
||||
msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:39
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:41
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:48
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:50
|
||||
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:52
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:54
|
||||
msgid "To use the bridge, start a chat with `@gvoicebot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:56
|
||||
msgid "Google Voice has no phone to pair and no QR code to scan. It logs in with cookies, which you copy from a browser already signed in to [voice.google.com](https://voice.google.com/) and hand to the bot. It is fiddlier than scanning a code and feels more suspicious than it is, but Google leaves no cleaner door open. The bridge's [official Authentication guide](https://docs.mau.fi/bridges/go/gvoice/authentication.html) has the exact cookies to grab and the steps for grabbing them."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:58
|
||||
msgid "Those cookies are a login session, and Google expires them on its own schedule. When they lapse the bridge goes quiet and you log in again. Nothing is broken, that is just how cookie auth ages."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:60
|
||||
msgid "Once you log in, the bridge builds portal rooms for your recent conversations and carries text and media both ways. Don't reach for it to start a brand-new chat or to place a call, though. That ground still belongs to Google Voice, so keep the app around for those."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:62
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:64
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-mautrix-gvoice`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:66
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-gvoice.md:68
|
||||
msgid "The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
msgstr ""
|
||||
+2
-2
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -53,7 +53,7 @@ msgid "If you've been using the [mautrix-instagram](./configuring-playbook-bridg
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:26
|
||||
msgid "both trying to use `@instagrambot:example.com` as their username. This conflict may be resolved by adjusting `matrix_mautrix_instagram_appservice_bot_username` or `matrix_mautrix_meta_instagram_appservice_username`"
|
||||
msgid "both trying to use `@instagrambot:example.com` as their username. This conflict may be resolved by adjusting `matrix_mautrix_instagram_appservice_bot_username` or `matrix_bridge_mautrix_meta_instagram_appservice_username`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-meta-instagram.md:27
|
||||
|
||||
+2
-2
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -113,7 +113,7 @@ msgid "(default) (`messenger`) Messenger via `messenger.com` — usable even wit
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:59
|
||||
msgid "You may switch the mode via the `matrix_mautrix_meta_messenger_meta_mode` variable. The playbook defaults to the `messenger` mode, because it's most universal (every Facebook user has a Messenger account, but the opposite is not true)."
|
||||
msgid "You may switch the mode via the `matrix_bridge_mautrix_meta_messenger_meta_mode` variable. The playbook defaults to the `messenger` mode, because it's most universal (every Facebook user has a Messenger account, but the opposite is not true)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-meta-messenger.md:61
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -45,7 +45,7 @@ msgid "If you're running with the Postgres database server integrated by the pla
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:31
|
||||
msgid "However, if you're [using an external Postgres server](configuring-playbook-external-postgres.md), you'd need to manually prepare a Postgres database for this bridge and adjust the variables related to that (`matrix_mautrix_signal_database_*`)."
|
||||
msgid "However, if you're [using an external Postgres server](configuring-playbook-external-postgres.md), you'd need to manually prepare a Postgres database for this bridge and adjust the variables related to that (`matrix_bridge_mautrix_signal_database_*`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-signal.md:33
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -61,7 +61,7 @@ msgid "Adjusting the wsproxy URL (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:41
|
||||
msgid "By tweaking the `matrix_mautrix_wsproxy_hostname` variable, you can easily make the service available at a **different hostname** than the default one."
|
||||
msgid "By tweaking the `matrix_bridge_mautrix_wsproxy_hostname` variable, you can easily make the service available at a **different hostname** than the default one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-mautrix-wsproxy.md:43
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-05-07 11:16+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -61,7 +61,7 @@ msgid "To enable the bridge, add the following configuration to your `inventory/
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-meshtastic-relay.md:56
|
||||
msgid "By default, the bot's Matrix ID is `@meshtasticbot:{{ matrix_domain }}`. To change it, adjust `matrix_meshtastic_relay_matrix_bot_user_id`."
|
||||
msgid "By default, the bot's Matrix ID is `@meshtasticbot:{{ matrix_domain }}`. To change it, adjust `matrix_bridge_meshtastic_relay_matrix_bot_user_id`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-meshtastic-relay.md:58
|
||||
@@ -69,7 +69,7 @@ msgid "Bluetooth (BLE) connections"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-meshtastic-relay.md:60
|
||||
msgid "When `matrix_meshtastic_relay_connection_type` is `ble`, the container runs with `--network=host` and bind-mounts the host's DBus socket — both are required for Bluetooth pairing/communication. Only use this connection type if you trust the playbook-managed host and are comfortable with these privileges."
|
||||
msgid "When `matrix_bridge_meshtastic_relay_connection_type` is `ble`, the container runs with `--network=host` and bind-mounts the host's DBus socket — both are required for Bluetooth pairing/communication. Only use this connection type if you trust the playbook-managed host and are comfortable with these privileges."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-meshtastic-relay.md:62
|
||||
@@ -77,7 +77,7 @@ msgid "Serial connections"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-meshtastic-relay.md:64
|
||||
msgid "When `matrix_meshtastic_relay_connection_type` is `serial`, the host device referenced by `matrix_meshtastic_relay_serial_port` is passed through to the container. Make sure that `matrix_user_uid` / `matrix_user_gid` have read/write access to that device (e.g. by adding the matrix user to the `dialout` group, or adjusting udev rules)."
|
||||
msgid "When `matrix_bridge_meshtastic_relay_connection_type` is `serial`, the host device referenced by `matrix_bridge_meshtastic_relay_serial_port` is passed through to the container. Make sure that `matrix_user_uid` / `matrix_user_gid` have read/write access to that device (e.g. by adding the matrix user to the `dialout` group, or adjusting udev rules)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-meshtastic-relay.md:66
|
||||
@@ -93,7 +93,7 @@ msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-meshtastic-relay.md:72
|
||||
msgid "`roles/custom/matrix-bridge-meshtastic-relay/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override individual `matrix_meshtastic_relay_*` variables, or make finer-grained adjustments via `matrix_meshtastic_relay_configuration_extension_yaml`."
|
||||
msgid "`roles/custom/matrix-bridge-meshtastic-relay/defaults/main.yml` for some variables that you can customize via your `vars.yml` file. You can override individual `matrix_bridge_meshtastic_relay_*` variables, or make finer-grained adjustments via `matrix_bridge_meshtastic_relay_configuration_extension_yaml`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-meshtastic-relay.md:74
|
||||
@@ -117,7 +117,7 @@ msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-meshtastic-relay.md:89
|
||||
msgid "Invite the bot to the Matrix rooms listed in `matrix_meshtastic_relay_matrix_rooms_list` and it will relay between Matrix and the corresponding Meshtastic channel. Messages sent on Meshtastic will appear in Matrix and vice versa."
|
||||
msgid "Invite the bot to the Matrix rooms listed in `matrix_bridge_meshtastic_relay_matrix_rooms_list` and it will relay between Matrix and the corresponding Meshtastic channel. Messages sent on Meshtastic will appear in Matrix and vice versa."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-meshtastic-relay.md:91
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-04-03 11:56+0100\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -53,7 +53,7 @@ msgid "If you don't open these ports, you will still be able to send emails, but
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-postmoogle.md:27
|
||||
msgid "These port numbers are configurable via the `matrix_postmoogle_smtp_host_bind_port` and `matrix_postmoogle_submission_host_bind_port` variables, but other email servers will try to deliver on these default (standard) ports, so changing them is of little use."
|
||||
msgid "These port numbers are configurable via the `matrix_bridge_postmoogle_smtp_host_bind_port` and `matrix_bridge_postmoogle_submission_host_bind_port` variables, but other email servers will try to deliver on these default (standard) ports, so changing them is of little use."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-postmoogle.md:29
|
||||
@@ -189,7 +189,7 @@ msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x f
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-postmoogle.md:90
|
||||
msgid "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 [Ketesa](configuring-playbook-ketesa.md) to change it, and then update `matrix_postmoogle_password` to let the bot know its new password."
|
||||
msgid "If you change the bridge's bot password (`matrix_bridge_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 [Ketesa](configuring-playbook-ketesa.md) to change it, and then update `matrix_bridge_postmoogle_password` to let the bot know its new password."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-postmoogle.md:92
|
||||
|
||||
@@ -0,0 +1,173 @@
|
||||
# SOME DESCRIPTIVE TITLE.
|
||||
# Copyright (C) 2018-2026, Slavi Pantaleev, Aine Etke, MDAD community members
|
||||
# This file is distributed under the same license as the matrix-docker-ansible-deploy package.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
||||
#
|
||||
#, fuzzy
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:8
|
||||
msgid "Setting up RustPush (iMessage) bridging (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:10
|
||||
msgid "**Note:** This bridge is in early development and may have stability issues. It may not be desirable to deploy this to a large number of users. Your testing and feedback is appreciated."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:12
|
||||
msgid "<sup>Refer the common guide for configuring mautrix bridges: [Setting up a Generic Mautrix Bridge](configuring-playbook-bridge-mautrix-bridges.md)</sup>"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:14
|
||||
msgid "The playbook can install and configure [RustPush bridge to iMessage](https://github.com/jasonlaguidice/imessage) for you using Apple's push notification service."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:16
|
||||
msgid "See the project's [documentation](https://github.com/jasonlaguidice/imessage/blob/main/README.md) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:18
|
||||
msgid "Prerequisites"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:20
|
||||
msgid "Hardware Key Extraction"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:22
|
||||
msgid "To use this bridge on Linux (Docker), each user needs a **hardware key** extracted from a real Mac. This key contains hardware identifiers needed for iMessage registration. Hardware keys can be shared by a number of users (approximately 20) before causing issues with Apple."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:24
|
||||
msgid "The key is entered interactively through the bridge bot's login flow (not configured via Ansible variables). See the upstream [README](https://github.com/jasonlaguidice/imessage/blob/main/README.md) for instructions on extracting the key."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:26
|
||||
msgid "If extracted from an Intel Mac, the Mac does not need to remain running after the key is extracted for this bridge to work. Apple Silicon Macs must run a NAC relay and thus must remain running."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:28
|
||||
msgid "Phone Number Registration (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:30
|
||||
msgid "This bridge can **not** do phone number registration (PNR). The only way to have your phone number registered and used (instead of an Apple ID e-mail address) is to have an iPhone connected to your Apple account. Reference the [BlueBubbles Phone Number Registration Guide](https://docs.bluebubbles.app/server/advanced/registering-a-phone-number-with-your-imessage-account) for information on how to set this up."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:32
|
||||
msgid "Enable Appservice Double Puppet (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:34
|
||||
msgid "If you want to set up [Double Puppeting](https://docs.mau.fi/bridges/general/double-puppeting.html) (hint: you most likely do) for this bridge automatically, you need to have enabled [Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) service for this playbook."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:36
|
||||
msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#set-up-double-puppeting-optional) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about setting up Double Puppeting."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:38
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:40
|
||||
msgid "To enable the bridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:46
|
||||
msgid "Disable Backfill (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:48
|
||||
msgid "Backfill can be disabled globally if desired via config. By default, the bridge will backfill from iCloud (CloudKit) and APNS if available. Backfill from `chat.db` is only possible when the bridge is running on MacOS."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:54
|
||||
msgid "Extending the Configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:56
|
||||
msgid "There are some additional things you may wish to configure about the bridge."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:58
|
||||
msgid "See [this section](configuring-playbook-bridge-mautrix-bridges.md#extending-the-configuration) on the [common guide for configuring mautrix bridges](configuring-playbook-bridge-mautrix-bridges.md) for details about variables that you can customize and the bridge's default configuration, including [bridge permissions](configuring-playbook-bridge-mautrix-bridges.md#configure-bridge-permissions-optional), [encryption support](configuring-playbook-bridge-mautrix-bridges.md#enable-encryption-optional), [bot's username](configuring-playbook-bridge-mautrix-bridges.md#set-the-bots-username-optional), etc."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:60
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:62
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:69
|
||||
msgid "**Notes**:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:71
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:73
|
||||
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:75
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:77
|
||||
msgid "To use the bridge, you need to start a chat with `@rustpushbot:example.com` (where `example.com` is your base domain, not the `matrix.` domain)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:79
|
||||
msgid "After logging in, the bridge will start receiving iMessages and creating portal rooms."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:81
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:83
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-rustpush-bridge`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:85
|
||||
msgid "Increase logging verbosity"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:87
|
||||
msgid "The default logging level for this component is `warn`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:96
|
||||
msgid "Notable Configuration Options"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:97
|
||||
msgid "`matrix_bridge_rustpush_statuskit_notifications` will display StatusKit information for conversation participants. In some clients, this update will cause the DM to be pushed to the top of the conversation list continuously, so this option is disabled by default."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:98
|
||||
msgid "`matrix_bridge_rustpush_statuskit_notification_style` can be set to either `topic` or `notice`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:99
|
||||
msgid "`topic` sets the status as a room topic. In supported clients (like Cinny and Sable), this will display `🔕 Focus` as a second line when the person has focus mode enabled."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-rustpush.md:100
|
||||
msgid "`notice` sends an `m.notice` event to the room which will display text in the room but should not generate a notification"
|
||||
msgstr ""
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -83,3 +83,11 @@ msgstr ""
|
||||
#: ../../../docs/configuring-playbook-bridge-steam.md:48
|
||||
msgid "Send `help` to the bot to see the available commands."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-steam.md:50
|
||||
msgid "Notable Configuration Options"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-steam.md:51
|
||||
msgid "`matrix_bridge_steam_network_presence_topic_enabled` and `matrix_bridge_steam_network_presence_topic_rich_presence_enabled` mirror Steam's [Enhanced Rich Presence](https://partner.steamgames.com/doc/features/enhancedrichpresence) feature in Matrix. This will display the user's current game and rich presence if supported by the game. This sets the DM room's `m.topic` field to achieve this. Some games (like Deadlock) update the rich presence every minute with a match timer. In some clients, the topic update will cause the DM to be pushed to the top of the conversation list continuously, so this option is disabled by default."
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-05-19 07:40+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -57,7 +57,7 @@ msgid "`roles/custom/matrix-bridge-wechat/defaults/main.yml` for some variables
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-wechat.md:32
|
||||
msgid "`roles/custom/matrix-bridge-wechat/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_wechat_configuration_extension_yaml` variable"
|
||||
msgid "`roles/custom/matrix-bridge-wechat/templates/config.yaml.j2` for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bridge_wechat_configuration_extension_yaml` variable"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-bridge-wechat.md:34
|
||||
|
||||
@@ -0,0 +1,141 @@
|
||||
# SOME DESCRIPTIVE TITLE.
|
||||
# Copyright (C) 2018-2026, Slavi Pantaleev, Aine Etke, MDAD community members
|
||||
# This file is distributed under the same license as the matrix-docker-ansible-deploy package.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
||||
#
|
||||
#, fuzzy
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-07-12 15:37+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:7
|
||||
msgid "Setting up Commet (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:9
|
||||
msgid "The playbook can install and configure the [Commet](https://github.com/commetchat/commet) Matrix web client for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:11
|
||||
msgid "Adjusting DNS records"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:13
|
||||
msgid "By default, this playbook installs Commet on the `commet.` subdomain (`commet.example.com`) and requires you to create a CNAME record for `commet`, which targets `matrix.example.com`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:15
|
||||
msgid "When setting, replace `example.com` with your own."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:17
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:19
|
||||
msgid "To enable Commet, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:25
|
||||
msgid "Adjusting the Commet URL (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:27
|
||||
msgid "By tweaking the `matrix_client_commet_hostname` and `matrix_client_commet_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:29
|
||||
msgid "Example additional configuration for your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:40
|
||||
msgid "After changing the domain, **you may need to adjust your DNS** records to point the Commet domain to the Matrix server."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:42
|
||||
msgid "If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:44
|
||||
msgid "**Note**: `matrix_client_commet_path_prefix` must either be `/` or not end with a slash (e.g. `/commet`)."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:46
|
||||
msgid "Adjusting the default homeserver (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:48
|
||||
msgid "Commet is configured with a `default_homeserver` value. By default, the playbook uses `matrix.org`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:50
|
||||
msgid "To change it, add the following configuration to your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:56
|
||||
msgid "Adjusting the Commet version/branch to build (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:58
|
||||
msgid "When self-building the container image (`matrix_client_commet_container_image_self_build: true`), the playbook checks out the Commet source repository and builds an image from it."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:60
|
||||
msgid "To build from a different git branch/tag/SHA, set `matrix_client_commet_version` in your `vars.yml` file:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:67
|
||||
msgid "**Note**: by default, the image tag is derived from `matrix_client_commet_version` (`localhost/matrix-client-commet:{{ matrix_client_commet_version }}`). If your branch name contains `/` (e.g. `feature/foo`), override `matrix_client_commet_container_image` (and optionally `matrix_client_commet_container_image_self_build_version_tag`) to a Docker-tag-safe value."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:69
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:71
|
||||
msgid "There are some additional things you may wish to configure about the component."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:73
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:75
|
||||
msgid "`roles/custom/matrix-client-commet/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:76
|
||||
msgid "`roles/custom/matrix-client-commet/templates/global_config.json.j2` for the component's default runtime configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:78
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:80
|
||||
msgid "After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:87
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:89
|
||||
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:91
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-commet.md:93
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-client-commet`."
|
||||
msgstr ""
|
||||
@@ -21,7 +21,7 @@ msgid "Setting up Sable (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-sable.md:11
|
||||
msgid "The playbook can install and configure the [Sable](https://github.com/7w1/sable) Matrix web client for you."
|
||||
msgid "The playbook can install and configure the [Sable](https://github.com/SableClient/Sable) Matrix web client for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-client-sable.md:13
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-05-07 11:16+0000\n"
|
||||
"POT-Creation-Date: 2026-07-16 13:47+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -81,5 +81,9 @@ msgid "To make it possible to proxy the federation through a CDN such as CloudFl
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-federation.md:74
|
||||
msgid "**Note**: `matrix_synapse_federation_port_enabled: false` only makes sense in this specific setup, where federation traffic is served through the client port (because of the `federation` entry in `matrix_synapse_http_listener_resource_names`). If federation still flows through the dedicated federation port on your setup (e.g. another reverse proxy of yours forwarding a custom public port to this playbook's federation port), leave `matrix_synapse_federation_port_enabled` at its default (enabled). Disabling it removes the federation route entirely and breaks such setups."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-federation.md:76
|
||||
msgid "**Use this at you own risk as all the possible side-effects of doing this are not fully known. However, it has been tested and works fine and passes all the tests on <https://federationtester.matrix.org/> without issues.**"
|
||||
msgstr ""
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-05-19 07:40+0000\n"
|
||||
"POT-Creation-Date: 2026-06-29 17:11+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -21,7 +21,7 @@ msgid "Setting up Ketesa (optional)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-ketesa.md:16
|
||||
msgid "The playbook can install and configure [Ketesa](https://github.com/etkecc/ketesa) for you."
|
||||
msgid "The playbook can install and configure [Ketesa](https://ketesa.app) ([source code](https://github.com/etkecc/ketesa)) for you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-ketesa.md:18
|
||||
@@ -33,7 +33,7 @@ msgid "Ketesa does not work with other homeserver implementations than Synapse d
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-ketesa.md:23
|
||||
msgid "The latest version of Ketesa is hosted by [etke.cc](https://etke.cc/) at [admin.etke.cc](https://admin.etke.cc/). If you only need this service occasionally and trust giving your admin credentials to a 3rd party Single Page Application, you can consider using it from there and avoiding the (small) overhead of self-hosting."
|
||||
msgid "The latest version of Ketesa is hosted by [etke.cc](https://etke.cc/) at [cloud.ketesa.app](https://cloud.ketesa.app/). If you only need this service occasionally and trust giving your admin credentials to a 3rd party Single Page Application, you can consider using it from there and avoiding the (small) overhead of self-hosting."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-ketesa.md:24
|
||||
|
||||
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-05-20 02:45+0000\n"
|
||||
"POT-Creation-Date: 2026-06-29 17:11+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -59,15 +59,3 @@ msgstr ""
|
||||
#: ../../../docs/configuring-playbook-ldap-auth.md:54
|
||||
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-ldap-auth.md:56
|
||||
msgid "Usage"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-ldap-auth.md:58
|
||||
msgid "Handling user registration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-ldap-auth.md:60
|
||||
msgid "If you wish for users to also be able to make new registrations against LDAP, you may **also** wish to [set up the ldap-registration-proxy](configuring-playbook-matrix-ldap-registration-proxy.md)."
|
||||
msgstr ""
|
||||
|
||||
+9
-65
@@ -8,7 +8,7 @@ msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-02-13 10:32+0000\n"
|
||||
"POT-Creation-Date: 2026-06-29 17:11+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
@@ -16,74 +16,18 @@ msgstr ""
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:9
|
||||
msgid "Setting up matrix-ldap-registration-proxy (optional)"
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:20
|
||||
msgid "Setting up matrix-ldap-registration-proxy (optional, removed)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:11
|
||||
msgid "The playbook can install and configure [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) for you."
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:22
|
||||
msgid "🪦 The playbook used to be able to install and configure [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy), but no longer includes this component, as it has become unavailable."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:13
|
||||
msgid "This proxy handles Matrix registration requests and forwards them to LDAP."
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:24
|
||||
msgid "Uninstalling the component manually"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:15
|
||||
msgid "See the project's [documentation](https://gitlab.com/activism.international/matrix_ldap_registration_proxy/-/blob/main/README.md) to learn what it does and why it might be useful to you."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:17
|
||||
msgid "**Note**: This does support the full Matrix specification for registrations. It only provide a very coarse implementation of a basic password registration."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:19
|
||||
msgid "Adjusting the playbook configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:21
|
||||
msgid "To enable the component, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file (adapt to your needs):"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:33
|
||||
msgid "If you already use the [synapse external password provider via LDAP](configuring-playbook-ldap-auth.md) (that is, you have `matrix_synapse_ext_password_provider_ldap_enabled: true` and other options in your configuration) you can use the following values as configuration:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:46
|
||||
msgid "Extending the configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:48
|
||||
msgid "There are some additional things you may wish to configure about the component."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:50
|
||||
msgid "Take a look at:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:52
|
||||
msgid "`roles/custom/matrix-ldap-registration-proxy/defaults/main.yml` for some variables that you can customize via your `vars.yml` file"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:54
|
||||
msgid "Installing"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:56
|
||||
msgid "After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:63
|
||||
msgid "The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:65
|
||||
msgid "`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:67
|
||||
msgid "Troubleshooting"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:69
|
||||
msgid "As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-ldap-registration-proxy`."
|
||||
#: ../../../docs/configuring-playbook-matrix-ldap-registration-proxy.md:26
|
||||
msgid "If you still have matrix-ldap-registration-proxy installed on your Matrix server, the playbook can no longer help you uninstall it and you will need to do it manually. To uninstall manually, run these commands on the server:"
|
||||
msgstr ""
|
||||
|
||||
@@ -0,0 +1,237 @@
|
||||
# SOME DESCRIPTIVE TITLE.
|
||||
# Copyright (C) 2018-2026, Slavi Pantaleev, Aine Etke, MDAD community members
|
||||
# This file is distributed under the same license as the matrix-docker-ansible-deploy package.
|
||||
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
|
||||
#
|
||||
#, fuzzy
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: matrix-docker-ansible-deploy \n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"POT-Creation-Date: 2026-06-29 17:11+0000\n"
|
||||
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
|
||||
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
|
||||
"Language-Team: LANGUAGE <LL@li.org>\n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: 8bit\n"
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:7
|
||||
msgid "Configuring Synology DSM"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:9
|
||||
msgid "This document is a guide for preparing Synology DSM for the installation of the [Matrix Docker Ansible Deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy) project."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:11
|
||||
msgid "**Note:** Synology DSM is a community-supported platform. It is not officially tested or maintained by the project maintainers. Use at your own discretion."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:13
|
||||
msgid "**Intended audience:** Users already familiar with DSM, SSH, and this Ansible project."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:15
|
||||
msgid "Assumptions"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:17
|
||||
msgid "DSM version 7 or higher"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:18
|
||||
msgid "`Volume1` is used as the default Docker storage location"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:19
|
||||
msgid "You are using DSM's built-in reverse proxy for handling HTTPS"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:21
|
||||
msgid "How Synology Support Works"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:23
|
||||
msgid "The playbook automatically detects Synology DSM by checking for `/etc/synoinfo.conf`. When detected, it:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:25
|
||||
msgid "Uses `synouser` and `synogroup` (DSM-native tools) instead of standard Linux user management"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:26
|
||||
msgid "Constrains the Python `requests` package to a version compatible with the Docker SDK"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:27
|
||||
msgid "Ensures `/volume1` has shared mount propagation so container bind mounts work correctly"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:28
|
||||
msgid "Deploys a `matrix-synology-boot-fix` service that runs on every boot after Docker is ready"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:30
|
||||
msgid "You can override auto-detection by setting `matrix_base_host_is_synology: true` or `false` in your `vars.yml`."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:32
|
||||
msgid "Matrix Service Account"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:34
|
||||
msgid "The playbook creates a `matrix` system account using Synology's `synouser` tool. The account is secured as follows:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:36
|
||||
msgid "**Expired** (`expired=1`) — the account cannot be used to log in to DSM or any application"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:38
|
||||
msgid "You must set a password for this account via `matrix_synology_user_password` in your `vars.yml` (see [vars.yml Configuration](#varsyml-configuration)). The password cannot be used to log in because the account is expired, but a non-empty password is required as an additional security layer."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:40
|
||||
msgid "If you pre-create the `matrix` user manually before running the playbook, the playbook will not modify the existing account's settings — you are responsible for securing it."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:42
|
||||
msgid "Boot-fix Service"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:44
|
||||
msgid "Synology DSM has two boot-time quirks that the boot-fix service addresses automatically:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:46
|
||||
msgid "**`/volume1` shared mount propagation**"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:48
|
||||
msgid "Docker requires `/volume1` to be mounted as shared (`mount --make-shared /volume1`) for container bind mounts with `bind-propagation=slave` to work correctly (used by matrix-synapse for its media store). On Synology, this cannot be inserted into the systemd chain before Container Manager starts — doing so causes Container Manager to detect a broken dependency and prompt for repair on every boot. The playbook applies this during setup, and the boot-fix service re-applies it on every subsequent reboot, safely outside Container Manager's dependency chain."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:50
|
||||
msgid "**Skipped services at boot**"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:52
|
||||
msgid "Synology's systemd drops services with multi-level dependency chains from the boot activation queue (e.g. `matrix-traefik → matrix-container-socket-proxy → docker`). These services show as `inactive` or `failed` after reboot even though they are enabled. The boot-fix service scans for any enabled `matrix-*.service` in either state and starts them automatically."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:54
|
||||
msgid "**If you previously configured a Task Scheduler entry** (`Control Panel > Task Scheduler`) to run `mount --make-shared /volume1` at boot-up, you can remove it — the boot-fix service now handles this."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:56
|
||||
msgid "Synology GUI Preparation"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:58
|
||||
msgid "**Enable SSH**"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:59
|
||||
msgid "`Control Panel` > `Terminal & SNMP` > `Enable SSH service`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:61
|
||||
msgid "**Enable SFTP**"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:62
|
||||
msgid "`Control Panel` > `File Service` > `FTP` > `Enable SFTP service` with default port"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:64
|
||||
msgid "**Enable User Home Directory**"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:65
|
||||
msgid "`Control Panel` > `User & Group` > `Advanced` > `Enable user home service`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:67
|
||||
msgid "**Install Container Manager**"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:68
|
||||
msgid "Install from `Package Center`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:70
|
||||
msgid "**Configure Reverse Proxy**"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:71
|
||||
msgid "`Control Panel` > `Login Portal` > `Advanced` > `Reverse Proxy`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:72
|
||||
msgid "Create entries for each service you enable (e.g. Matrix, Element, admin page)"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:73
|
||||
msgid "Example entry:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:74
|
||||
msgid "Source: `HTTPS` / `matrix.example.com` / port `443`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:75
|
||||
msgid "Destination: `HTTP` / `localhost` / port `81`"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:77
|
||||
msgid "SSH Preparation"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:79
|
||||
msgid "(Optional but Recommended) Enable SSH Key Authentication"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:81
|
||||
msgid "Configure key-based SSH login to avoid password prompts during Ansible runs."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:83
|
||||
msgid "Set Up the Ansible Environment"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:85
|
||||
msgid "Create a project folder and Python virtual environment on the DSM host:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:96
|
||||
msgid "Inventory Configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:98
|
||||
msgid "In your `inventory/hosts` file, set the Python interpreter to your virtual environment:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:105
|
||||
msgid "vars.yml Configuration"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:107
|
||||
msgid "Add the following Synology-specific variables to your `vars.yml`:"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:151
|
||||
msgid "Running the Playbook"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:167
|
||||
msgid "**Important:** Always include `stop` before `setup-all,start` when changing configuration. Running `setup-all` alone does not restart already-running containers."
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:169
|
||||
msgid "Creating Matrix Users"
|
||||
msgstr ""
|
||||
|
||||
#: ../../../docs/configuring-playbook-synology.md:171
|
||||
msgid "After the services are running, create your first Matrix user:"
|
||||
msgstr ""
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user