matrix-docker-ansible-deploy/docs
Slavi Pantaleev e46ba5deba Add matrix-appservice-kakaotalk support
Adds support for: https://src.miscworks.net/fair/matrix-appservice-kakaotalk

This is pretty similar to
https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/1977
which just appeared, but has mostly been done independently.

I've taken some inspiration and did some fixups based on that PR.
Thanks to https://github.com/hnarjis for taking the time to contribute!

Notable differences between this branch compared to that PR:

- better naming and documentation around the "configuration" variables
- no unnecessary (5 sec.) intentional delay when starting `matrix-appservice-kakaotalk-node.service`
- stores configuration in `config/`, not in `data/`
- passes configuration as read-only and starts the bridge with (`--no-update`) to ensure no changes are made to it
- starts containers more securely - with `matrix:matrix` user:group (not `root`) and
  reduced capabilities (`--cap-drop=ALL`)
- uses `tcp` for communication between the "node" and the appservice (simpler than sharing unix sockets)
- `registration.yaml` which is closer to the one generated by `matrix-appservice-kakaotalk` (no `de.sorunome.msc2409.push_ephemeral` stuff, etc.)
- `registration.yaml` which is more customizable (customizable bot username and prefix for puppets - see `matrix_appservice_kakaotalk_appservice_bot_username` and `matrix_appservice_kakaotalk_user_prefix`)
- less fragile and more extensible bridge permissions configuration via `matrix_appservice_kakaotalk_bridge_permissions`. Doing `{% if matrix_admin %}` in the bridge configuration sometimes causes syntax problems (I hit some myself) and is not ideal. Other bridges should be redone as well.
- configurable command prefix for the bridge, instead of hardcoding `!kt` (see `matrix_appservice_kakaotalk_command_prefix`)
- logging that is more consistent with the rest of the playbook (console / journald only, no logging to files), as well as configurable log level (via `matrix_appservice_kakaotalk_logging_level`)
- somewhat more detailed documentation (`docs/configuring-playbook-bridge-appservice-kakaotalk.md`)
- removed some dead code (data relocation tasks from `tasks/setup_install.yml`, as well as likely unnecessary SQLite -> Postgres migration)
2022-07-25 16:01:15 +03:00
..
assets Add matrix-registration-bot (#1771) 2022-04-21 11:07:47 +03:00
alternative-architectures.md Fix file name (vars.yaml -> vars.yml) to prevent confusion 2022-04-26 15:44:07 +03:00
ansible.md update PIP install-link 2022-06-09 14:09:47 +02:00
configuring-captcha.md
configuring-dns.md update buscarron from github -> gitlab 2022-07-16 15:33:30 +00:00
configuring-playbook-backup-borg.md Add hint about matrix_backup_borg_ssh_key_private indentation 2022-07-21 17:07:06 +03:00
configuring-playbook-base-domain-serving.md
configuring-playbook-bot-buscarron.md matrix-bot-buscarron: fix username in docs 2022-04-25 12:36:27 +03:00
configuring-playbook-bot-go-neb.md Fix go-neb sample configuration to not clash with Jinja2 2022-01-15 09:07:24 +02:00
configuring-playbook-bot-honoroit.md
configuring-playbook-bot-matrix-registration-bot.md Fixed documentation to reflect needed user 2022-04-21 06:50:24 -05:00
configuring-playbook-bot-matrix-reminder-bot.md docs: fix matrix-reminder-bot help menu command 2022-02-02 12:35:12 +05:30
configuring-playbook-bot-maubot.md Clear up maubot role (#1960) 2022-07-20 12:23:32 +03:00
configuring-playbook-bot-mjolnir.md
configuring-playbook-bridge-appservice-discord.md docs(appservice-discord): improve and expand bridging method docs 2022-03-06 01:56:24 +00:00
configuring-playbook-bridge-appservice-irc.md
configuring-playbook-bridge-appservice-kakaotalk.md Add matrix-appservice-kakaotalk support 2022-07-25 16:01:15 +03:00
configuring-playbook-bridge-appservice-slack.md Riot is now named Element 2022-03-08 09:11:04 +01:00
configuring-playbook-bridge-appservice-webhooks.md Link appservice-webhooks to hookshot 2022-02-01 13:25:02 +01:00
configuring-playbook-bridge-beeper-linkedin.md
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
configuring-playbook-bridge-hookshot.md (BC Break) Redo how metrics are exposed to external Prometheus servers 2022-06-23 17:55:07 +03:00
configuring-playbook-bridge-matrix-bridge-sms.md
configuring-playbook-bridge-mautrix-facebook.md FIx code blocks 2022-07-01 08:42:23 +03:00
configuring-playbook-bridge-mautrix-googlechat.md
configuring-playbook-bridge-mautrix-hangouts.md
configuring-playbook-bridge-mautrix-instagram.md Mention matrix_admin 2022-06-30 11:57:01 +03:00
configuring-playbook-bridge-mautrix-signal.md
configuring-playbook-bridge-mautrix-telegram.md Improved documentation about permissions 2022-03-17 20:20:43 +00:00
configuring-playbook-bridge-mautrix-twitter.md
configuring-playbook-bridge-mautrix-whatsapp.md
configuring-playbook-bridge-mx-puppet-discord.md Switch to the Beeper-maintained fork of mx-puppet-discord 2022-03-10 12:27:53 +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 Switch mx-puppet-slack to the beeper fork (#1704) 2022-03-17 22:16:17 +02:00
configuring-playbook-bridge-mx-puppet-steam.md
configuring-playbook-bridge-mx-puppet-twitter.md
configuring-playbook-client-cinny.md
configuring-playbook-client-element.md
configuring-playbook-client-hydrogen.md
configuring-playbook-dimension.md Update configuring-playbook-dimension.md 2022-03-18 14:52:25 -06:00
configuring-playbook-dynamic-dns.md
configuring-playbook-email.md
configuring-playbook-email2matrix.md
configuring-playbook-etherpad.md
configuring-playbook-external-postgres.md Document that using an external Postgres server has serious downsides 2022-03-08 09:30:20 +02:00
configuring-playbook-federation.md fix typo 2022-02-20 11:56:03 +01:00
configuring-playbook-jitsi.md
configuring-playbook-ldap-auth.md
configuring-playbook-ma1sd.md Do not install the ma1sd identity server by default 2022-03-17 18:00:09 +02:00
configuring-playbook-matrix-corporal.md
configuring-playbook-matrix-registration.md Fix self-building for matrix-registration 2022-06-01 09:43:31 +03:00
configuring-playbook-mautrix-bridges.md Creating generic mautrix bridge doc (#1912) 2022-07-08 18:06:37 +03:00
configuring-playbook-nginx.md
configuring-playbook-ntfy.md matrix-ntfy: more detailed usage docs for SchildiChat 2022-07-08 13:18:30 +01:00
configuring-playbook-own-webserver.md Update configuring-playbook-own-webserver.md 2022-06-30 03:46:24 -08:00
configuring-playbook-postgres-backup.md Announce borg backup support 2022-04-19 19:29:41 +03:00
configuring-playbook-prometheus-grafana.md Added a note on managing the basic_auth password on external prometheus 2022-06-24 17:45:52 +02:00
configuring-playbook-prometheus-postgres.md (BC Break) Redo how metrics are exposed to external Prometheus servers 2022-06-23 17:55:07 +03:00
configuring-playbook-rest-auth.md
configuring-playbook-riot-web.md
configuring-playbook-s3.md
configuring-playbook-shared-secret-auth.md
configuring-playbook-ssl-certificates.md matrix-ntfy: documentation 2022-07-04 15:32:07 +01:00
configuring-playbook-sygnal.md
configuring-playbook-synapse-admin.md
configuring-playbook-synapse-simple-antispam.md
configuring-playbook-synapse.md
configuring-playbook-telemetry.md Explicitly mention that your homeserver's domain is included in telemetry 2022-07-19 16:42:53 +00:00
configuring-playbook-turn.md
configuring-playbook.md Add matrix-appservice-kakaotalk support 2022-07-25 16:01:15 +03:00
configuring-well-known.md Update configuring-well-known.md 2022-07-20 12:10:34 -06:00
container-images.md Merge pull request #1958 from xangelix/migrate-mx-puppet-groupme-repo 2022-07-25 15:15:06 +03:00
faq.md Change list of public servers, old as not functional 2022-04-22 07:41:10 +02:00
getting-the-playbook.md
howto-server-delegation.md
importing-postgres.md
importing-synapse-media-store.md
importing-synapse-sqlite.md
installing.md
maintenance-and-troubleshooting.md
maintenance-checking-services.md
maintenance-migrating.md
maintenance-postgres.md
maintenance-synapse.md
maintenance-upgrading-services.md
prerequisites.md Document git as a potential prereq 2022-05-16 04:36:18 +00:00
README.md
registering-users.md
self-building.md Announce maubot 2022-07-20 12:55:18 +03:00
uninstalling.md
updating-users-passwords.md