mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-01-22 10:49:35 +00:00

Replace old warnings with Github Markdown Warnings

I executed a Search for `⚠️ **Warning**:` and replaced it with
```
> [!WARNING]
>
```

I also capitalised the first letter where missing.

Draupnir Docs have been excluded from this Commit as to not cause a separate PR im working on for the Draupnir docs to have potential merge conflicts and im making said change in that document too.

2025-01-20 14:39:40 +01:00

3.5 KiB

Raw Blame History

Setting up Appservice Kakaotalk bridging (optional)

The playbook can install and configure matrix-appservice-kakaotalk for you, for bridging to Kakaotalk. This bridge is based on node-kakao (now unmaintained) and some mautrix-facebook code.

See the project's documentation to learn what it does and why it might be useful to you.

Warning

There have been recent reports (~2022-09-16) that using this bridge may get your account banned.

Prerequisite (optional)

Enable Shared Secret Auth

If you want to set up Double Puppeting (hint: you most likely do) for this bridge automatically, you need to have enabled Shared Secret Auth for this playbook.

See this section on the common guide for configuring mautrix bridges 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:

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 as below:

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 are also available: just install-all or just setup-all

just install-all is useful for maintaining your setup quickly (2x-5x faster 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 @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.

3.5 KiB Raw Blame History