ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-09-19 00:25:18 +00:00
Code Issues Projects Releases Wiki Activity
70fd20cef5
matrix-docker-ansible-deploy/docs
History
Slavi Pantaleev 70fd20cef5 Add support for WeChat bridging 
This is based on the PR (https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3241)
by Tobias Diez (https://github.com/tobiasdiez).

I've refactored some parts, made it more configurable, polished it up,
and it's integrated into the playbook now.

Both the WeChat bridge and WeChat agent appear to be working.
The WeChat bridge joins rooms and responds as expected.

That said, end-to-end testing (actually bridging to a WeChat account) has not been done yet.

Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/701

Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3092

This is sponsored https://etke.cc/ work related to https://gitlab.com/etke.cc/ansible/-/issues/2

Squashed commit of the following:

commit fdd37f02472a0b83d61b4fac80650442f90e7629
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 21:05:53 2024 +0300

    Add documentation for WeChat bridge

commit 8426fc8b95bb160ea7f9659bd45bc59cf1326614
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 20:59:42 2024 +0300

    Rename directory for matrix_wechat_agent_container_src_files_path

commit da200df82bbc9153d307095dd90e4769c400ea1e
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 20:58:26 2024 +0300

    Make WeChat listen_secret configurable and auto-configured via matrix_homeserver_generic_secret_key

commit 4022cb1355828ac16af7d9228cb1066962bb35f5
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 20:54:56 2024 +0300

    Refactor install.yml for WeChat a bit (using blocks, etc.)

commit d07a39b4c4f6b93d04204e13e384086d5a242d52
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 20:52:35 2024 +0300

    Rename WeChat Agent configuration file

    This makes it more clear that it belongs to the agent.
    Otherwise, `config.yaml` and `configure.yaml` make you wonder.

commit ccca72f8d1e602f7c42f4bd552193afa153c9b9d
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 20:49:06 2024 +0300

    Move WeChat agent configuration to a template

commit a4047d94d8877b4095712dfc76ac3082a1edca28
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 20:47:17 2024 +0300

    Mount WeChat config as readonly and instruct bridge to not update it

commit bc0e89f345bf14bbdbfd574bb60d93918c2ac053
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 20:46:33 2024 +0300

    Sync WeChat config with upstream

    Brings up-to-date with:
    https://github.com/duo/matrix-wechat/commits/0.2.4/example-config.yaml

commit a46f5b9cbc8bf16042685a18c77d25a606bc8232
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 19:48:17 2024 +0300

    Rename some files

commit 3877679040cffc4ca6cccfa21a7335f8f796f06e
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 19:47:10 2024 +0300

    Update WeChat logging config

    This brings it up-to-date with what mautrix-go uses.
    Otherwise, on startup we see:

    > Migrating legacy log config

    .. and it gets migrated to what we've done here.

commit e3e95ab234651867c7a975a08455549b31db4172
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 19:43:37 2024 +0300

    Make sure matrix-wechat-agent runs as 1000:1000

    It needs to write stuff to `/home/user/.vnc`.

    `/home/user` is owned by `user:group` (`1000:1000`), so it cannot run
    any other way.

    Previously, if the `matrix` user was uid=1000 by chance, it would work,
    but that's pure luck.

commit 4d5748ae9b84c81d6b48b0a41b790339d9ac4724
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 18:57:09 2024 +0300

    Pin wechat and wechat-agent versions

commit 40d40009f19ebceed4126146cbb510a2c95af671
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 18:53:58 2024 +0300

    docker_image -> container_image for WeChat bridge

commit cc33aff592541913070d13288d17b04ed6243176
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 18:00:25 2024 +0300

    docker_src -> container_src in WeChat bridge

commit 42e6ae9a6483c8ca6d53b8052058d41d90d93797
Author: Slavi Pantaleev <slavi@devture.com>
Date:   Mon Jun 3 17:54:24 2024 +0300

    matrix_go_wechat_ -> matrix_wechat_

    The bridge is written in Go, but does not include Go anywhere in its
    name. As such, it's mostly useless to use `matrix_go_wechat` as the
    prefix.

commit d6662a69d1916d215d5184320c36d2ef73afd3e9
Author: Tobias Diez <code@tobiasdiez.de>
Date:   Mon Mar 25 10:55:16 2024 +0800

    Add wechat bridge
2024-06-03 21:28:50 +03:00
..
assets
alternative-architectures.md Determine matrix_architecture automatically 2022-11-22 09:22:56 +02:00
ansible.md Upgrade devture/ansible (2.14.5-r0-0 -> 2.16.1-r0-0) 2023-12-16 09:59:07 +02:00
configuring-captcha.md Replace (almost) all matrix-org/synapse references with element-hq/synapse 2024-01-17 08:02:47 +02:00
configuring-dns.md refactor: update links to avoid future issue 2023-12-15 11:18:18 +01:00
configuring-playbook-appservice-draupnir-for-all.md Fix D4A Documentation flaw 2024-03-19 21:51:36 +01:00
configuring-playbook-backup-borg.md Fix outdated documentation leading to matrix-backup-borg 2023-02-13 13:16:55 +02:00
configuring-playbook-base-domain-serving.md Fix incorrect variable name for base-domain root-path redirection 2024-02-03 18:48:24 +02:00
configuring-playbook-bot-buscarron.md Remove all traces of matrix-nginx-proxy, add validation & uninstallation tasks 2024-01-14 18:42:14 +02:00
configuring-playbook-bot-chatgpt.md Add system promt variable to docs 2023-07-30 04:50:05 +02:00
configuring-playbook-bot-draupnir.md Improve Pantalaimon Support in Draupnir and add Mjolnir support 2024-03-24 21:55:21 +01:00
configuring-playbook-bot-go-neb.md Replace (almost) all matrix-org/synapse references with element-hq/synapse 2024-01-17 08:02:47 +02:00
configuring-playbook-bot-honoroit.md Default matrix_bot_honoroit_path_prefix to /honoroit to avoid conflicts with Matrix Client-Server API 2023-05-18 10:10:47 +03:00
configuring-playbook-bot-matrix-registration-bot.md Fix typo in configuring-playbook-bot-matrix-registration-bot.md (#3137) 2024-01-28 06:56:43 +02:00
configuring-playbook-bot-matrix-reminder-bot.md Add matrix-user-creator role - automatic user account creation support 2022-11-01 16:22:58 +02:00
configuring-playbook-bot-maubot.md Update configuring-playbook-bot-maubot.md 2024-02-13 17:42:09 +01:00
configuring-playbook-bot-mjolnir.md Improve Pantalaimon Support in Draupnir and add Mjolnir support 2024-03-24 21:55:21 +01:00
configuring-playbook-bot-postmoogle.md Fixing typos and rewording 2023-05-30 09:09:24 +03:00
configuring-playbook-bridge-appservice-discord.md Update docs for older appservice bridges to enable legacy authorization (#2841) 2023-08-25 15:53:28 +03:00
configuring-playbook-bridge-appservice-irc.md
configuring-playbook-bridge-appservice-kakaotalk.md Move roles/matrix* to roles/custom/matrix* 2022-11-03 09:11:29 +02:00
configuring-playbook-bridge-appservice-slack.md Add puppeting option to matrix-bridge-appservice-slack 2024-05-14 16:39:16 +02:00
configuring-playbook-bridge-appservice-webhooks.md Update docs for older appservice bridges to enable legacy authorization (#2841) 2023-08-25 15:53:28 +03:00
configuring-playbook-bridge-beeper-linkedin.md Update configuring-playbook-bridge-beeper-linkedin.md 2023-11-06 08:51:50 +01:00
configuring-playbook-bridge-go-skype-bridge.md docs/configuring-playbook-bridge-go-skype-bridge: Fixups 2022-06-13 06:40:15 +00:00
configuring-playbook-bridge-heisenbridge.md Move roles/matrix* to roles/custom/matrix* 2022-11-03 09:11:29 +02:00
configuring-playbook-bridge-hookshot.md Remove all traces of matrix-nginx-proxy, add validation & uninstallation tasks 2024-01-14 18:42:14 +02:00
configuring-playbook-bridge-matrix-bridge-sms.md Update configuring-playbook-bridge-matrix-bridge-sms.md 2020-11-25 15:39:14 +01:00
configuring-playbook-bridge-mautrix-discord.md Merge pull request #2222 from array-in-a-matrix/master 2022-11-09 09:10:04 +02:00
configuring-playbook-bridge-mautrix-facebook.md Add support for bridging to Facebook Messenger and Instagram via mautrix-meta 2024-02-19 10:25:00 +02:00
configuring-playbook-bridge-mautrix-gmessages.md Announce mautrix-gmessages support 2023-07-21 14:37:05 +03:00
configuring-playbook-bridge-mautrix-googlechat.md Create dedicated doc page on obtaining access tokens 2022-08-20 11:47:14 +02:00
configuring-playbook-bridge-mautrix-hangouts.md Create dedicated doc page on obtaining access tokens 2022-08-20 11:47:14 +02:00
configuring-playbook-bridge-mautrix-instagram.md Add support for bridging to Facebook Messenger and Instagram via mautrix-meta 2024-02-19 10:25:00 +02:00
configuring-playbook-bridge-mautrix-meta-instagram.md Fix matrix_mautrix_meta_instagram_bridge_permissions_custom to use a dict 2024-04-04 11:04:03 +03:00
configuring-playbook-bridge-mautrix-meta-messenger.md Meta messenger documentation clarification 2024-04-04 10:00:40 +02:00
configuring-playbook-bridge-mautrix-signal.md Fix documentation bug in configuring-playbook-bridge-mautrix-signal.md 2024-02-20 19:20:25 +01:00
configuring-playbook-bridge-mautrix-slack.md Update configuring-playbook-bridge-mautrix-slack.md 2023-02-15 17:14:09 +00:00
configuring-playbook-bridge-mautrix-telegram.md update docs to exclude grou-sync 2022-10-15 14:43:25 +02:00
configuring-playbook-bridge-mautrix-twitter.md
configuring-playbook-bridge-mautrix-whatsapp.md Update configuring-playbook-bridge-mautrix-whatsapp.md 2024-02-08 03:44:38 +00:00
configuring-playbook-bridge-mautrix-wsproxy.md Add DNS section to wsproxy docs 2023-08-23 15:17:03 +03:00
configuring-playbook-bridge-mx-puppet-discord.md discord-bridges - fixing grammar mistakes, thanks @spontaleev 2022-08-03 09:33:52 +02:00
configuring-playbook-bridge-mx-puppet-groupme.md Migrate mx-puppet-groupme to new repo 2022-07-19 19:02:32 -04:00
configuring-playbook-bridge-mx-puppet-instagram.md
configuring-playbook-bridge-mx-puppet-skype.md Remove matrix-bridge-mx-puppet-skype role 2022-07-14 18:09:19 +03:00
configuring-playbook-bridge-mx-puppet-slack.md Announce maurtix-slack 2023-01-11 10:38:54 +02:00
configuring-playbook-bridge-mx-puppet-steam.md Remove unused variables from mx-puppet-* bridges 2021-06-23 09:56:31 +03:00
configuring-playbook-bridge-mx-puppet-twitter.md
configuring-playbook-bridge-wechat.md Add support for WeChat bridging 2024-06-03 21:28:50 +03:00
configuring-playbook-cactus-comments.md Add matrix-cactus-comments-client role 2024-01-09 09:53:01 +02:00
configuring-playbook-client-cinny.md
configuring-playbook-client-element.md refactor: update links to avoid future issue 2023-12-15 11:18:18 +01:00
configuring-playbook-client-hydrogen.md refactor: update links to avoid future issue 2023-12-15 11:18:18 +01:00
configuring-playbook-client-schildichat.md Update SchiliChat to v1.11.36 2024-02-26 14:25:04 +09:00
configuring-playbook-conduit.md Replace (almost) all matrix-org/synapse references with element-hq/synapse 2024-01-17 08:02:47 +02:00
configuring-playbook-dendrite.md Replace (almost) all matrix-org/synapse references with element-hq/synapse 2024-01-17 08:02:47 +02:00
configuring-playbook-dimension.md Add new global variable for controlling federation regardless of homeserver implementation 2024-01-14 11:52:40 +02:00
configuring-playbook-dynamic-dns.md
configuring-playbook-email.md Replace matrix-mailer with an external role 2024-01-05 17:54:50 +02:00
configuring-playbook-email2matrix.md Adjust email2matrix docs with regard to the homeserver container URL 2024-01-13 18:15:15 +02:00
configuring-playbook-etherpad.md Remove etherpad-proxy-connect role 2024-01-12 17:22:46 +02:00
configuring-playbook-external-postgres.md Switch from matrix-postgres to com.devture.ansible.role.postgres 2022-11-27 08:04:31 +02:00
configuring-playbook-federation.md Update configuring-playbook-federation.md 2024-02-25 09:20:11 +01:00
configuring-playbook-jitsi.md refactor: update links to avoid future issue 2023-12-15 11:18:18 +01:00
configuring-playbook-ldap-auth.md Add support for backup LDAP servers (#2650) 2023-04-19 08:52:03 +03:00
configuring-playbook-ma1sd.md Move matrix-ma1sd to its own container network and add native Traefik support 2024-01-09 15:27:13 +02:00
configuring-playbook-matrix-corporal.md Update aux role documentation, removing old matrix-aux references 2023-05-12 07:01:04 +03:00
configuring-playbook-matrix-ldap-registration-proxy.md Remove matrix_ldap_registration_proxy_container_additional_networks_custom mention in docs 2024-01-09 11:51:46 +02:00
configuring-playbook-matrix-media-repo.md Updated MMR docs with updated fields in main.yaml (#3047) 2023-12-18 11:01:59 +02:00
configuring-playbook-matrix-registration.md Specify relation between matrix-registration and matrix-registration-bot 2022-12-12 15:18:05 +01:00
configuring-playbook-mautrix-bridges.md docs: use available encryption vars instead of configuration extension 2024-03-24 03:02:11 +00:00
configuring-playbook-nginx.md Remove all traces of matrix-nginx-proxy, add validation & uninstallation tasks 2024-01-14 18:42:14 +02:00
configuring-playbook-ntfy.md Update configuring-playbook-ntfy.md 2023-03-22 11:28:34 +02:00
configuring-playbook-own-webserver.md add missing ' in config 2024-01-24 19:22:35 +01:00
configuring-playbook-pantalaimon.md Update Pantalaimon docs page to mention Mjolnir 2024-03-25 07:06:52 +02:00
configuring-playbook-postgres-backup.md Fix variable name typos in docs/configuring-playbook-postgres-backup.md 2023-02-27 17:57:36 +02:00
configuring-playbook-prometheus-grafana.md Replace (almost) all matrix-org/synapse references with element-hq/synapse 2024-01-17 08:02:47 +02:00
configuring-playbook-prometheus-nginxlog.md Remove matrix-homeserver-proxy role in favor of the new internal Traefik entrypoint 2024-01-14 10:53:14 +02:00
configuring-playbook-prometheus-postgres.md Update documentation related to variables for prometheus-node-exporter/prometheus-postgres-exporter metrics exposure 2024-01-12 18:04:18 +02:00
configuring-playbook-rageshake.md Remove all traces of matrix-nginx-proxy, add validation & uninstallation tasks 2024-01-14 18:42:14 +02:00
configuring-playbook-rest-auth.md Replace mxisd with ma1sd in docs, fixing URLs 2020-04-02 11:26:30 +02:00
configuring-playbook-riot-web.md Drop some matrix_nginx_proxy_proxy_riot_compat_* variables 2024-01-03 14:43:45 +02:00
configuring-playbook-s3-goofys.md Update "b2 sync" commands 2022-10-14 18:07:10 +03:00
configuring-playbook-s3.md Announce matrix-media-repo 2023-07-17 22:38:44 +03:00
configuring-playbook-shared-secret-auth.md Mention pwgen for generating a strong shared secret 2020-05-29 10:38:12 +03:00
configuring-playbook-sliding-sync-proxy.md Remove all traces of matrix-nginx-proxy, add validation & uninstallation tasks 2024-01-14 18:42:14 +02:00
configuring-playbook-ssl-certificates.md Remove tabs from YAML code snippets 2023-11-15 09:26:20 +02:00
configuring-playbook-sygnal.md Remove all traces of matrix-nginx-proxy, add validation & uninstallation tasks 2024-01-14 18:42:14 +02:00
configuring-playbook-synapse-admin.md Add missing link to synapse config docs 2024-02-12 23:10:50 -05:00
configuring-playbook-synapse-auto-accept-invite.md Add Synapse module auto accept invite to rooms and direct messages (#3195) 2024-02-21 18:04:14 +02:00
configuring-playbook-synapse-auto-compressor.md Minor rewording 2023-03-12 09:44:43 +02:00
configuring-playbook-synapse-s3-storage-provider.md Adjust S3 docs section to not be so Wasabi-specific 2023-06-16 09:11:53 +03:00
configuring-playbook-synapse-simple-antispam.md
configuring-playbook-synapse.md Rework Synapse workers documentation 2024-01-20 12:41:21 +02:00
configuring-playbook-telemetry.md Replace (almost) all matrix-org/synapse references with element-hq/synapse 2024-01-17 08:02:47 +02:00
configuring-playbook-traefik.md Add upstream proxy_protocol instructions to traefik (#3150) 2024-02-02 22:09:21 +02:00
configuring-playbook-turn.md Add lt-cred-mech authentication mechanism to Coturn 2024-02-18 09:52:00 +02:00
configuring-playbook-user-verification-service.md Introduced flags to (1) enable/disable Auth (2) enable/disable openid_server_name pinning. Updated validate_config.yml and added new checks to verify. 2023-02-06 15:59:32 +01:00
configuring-playbook.md Add support for WeChat bridging 2024-06-03 21:28:50 +03:00
configuring-well-known.md Merge branch 'master' into bye-bye-nginx-proxy 2024-01-09 15:38:23 +02:00
container-images.md Update container-images.md to mention Draupnir 2024-02-11 23:28:45 +01:00
faq.md Replace (almost) all matrix-org/synapse references with element-hq/synapse 2024-01-17 08:02:47 +02:00
getting-the-playbook.md Improve documentation about getting the playbook 2019-03-10 17:02:20 +02:00
howto-server-delegation.md Remove all traces of matrix-nginx-proxy, add validation & uninstallation tasks 2024-01-14 18:42:14 +02:00
howto-srv-server-delegation.md Update SRV delegation docs 2024-02-10 10:18:46 +01:00
importing-postgres.md Add note about ANALYZE after Postgres database importing 2023-09-26 17:52:01 +03:00
importing-synapse-media-store.md Rename some doc files and commands related to importing 2020-12-14 01:51:00 +02:00
importing-synapse-sqlite.md Restore --tags=import-synapse-sqlite-db support 2023-05-02 13:34:42 +03:00
installing.md Fix file name typo 2023-03-15 14:14:35 +02:00
maintenance-and-troubleshooting.md Replace (almost) all matrix-org/synapse references with element-hq/synapse 2024-01-17 08:02:47 +02:00
maintenance-checking-services.md Update URL for Matrix federation tester 2019-05-09 07:04:46 +02:00
maintenance-migrating.md Add a small tip to maintenance-migrating.md 2023-08-30 10:00:32 +02:00
maintenance-postgres.md Update maintenance-postgres.md 2024-05-05 08:53:18 +02:00
maintenance-synapse.md fix(docs): minor typo 2024-05-10 15:11:13 +02:00
maintenance-upgrading-services.md Add justfile 2023-01-11 15:12:05 +02:00
obtaining-access-tokens.md Improve wording and fix syntax trouble 2022-08-21 10:07:22 +03:00
prerequisites.md Update supported distros list 2024-02-14 15:54:53 +02:00
README.md
registering-users.md Add justfile 2023-01-11 15:12:05 +02:00
self-building.md Add Pantalaimon support 2024-03-24 18:35:34 +02:00
uninstalling.md /usr/local/bin/matrix-remove-all -> /matrix/bin/remove-all 2022-11-27 09:47:02 +02:00
updating-users-passwords.md Replace (almost) all matrix-org/synapse references with element-hq/synapse 2024-01-17 08:02:47 +02:00

README.md

Table of Contents