543f2a5c76
* Update docs/configuring-playbook-bridge-appservice-kakaotalk.md: fix the header for adjusting the playbook configuration
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Move sections "Set up Double Puppeting" under "Usage" as subsections for mautrix bridges and appservice kakaotalk
The changes in this commit reflect double puppeting configuration flow. Since the docs claim that double puppeting can be set up after enabling bridges by chatting with the bridge's bot, the explanation about double puppeting may well be placed under "Usage" as subsection.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Remove notes about setting up double puppeting manually
Since this method is explained after configuring bridges, those notes are no longer necessary.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs for mautrix and kakaotalk bridges: add prerequisite(s) section for instructing to install Appservice Double Puppet and/or Shared Secret Auth service
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Replace "Enabling Appservice Double Puppet" with "This"
Enabling Appservice Double Puppet is contrasted with "Enabling double puppeting by enabling the Shared Secret Auth service", therefore it can be just called as "this" if Shared Secret Auth service is not mentioned below.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-bridge-beeper-linkedin.md: follow other instances
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Add 💡 (Light Bulb: U+1F4A1) to the headings
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---------
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
3.7 KiB
Setting up Appservice Kakaotalk bridging (optional)
The playbook can install and configure matrix-appservice-kakaotalk for you. matrix-appservice-kakaotalk is a bridge to Kakaotalk based on node-kakao (now unmaintained) and some mautrix-facebook code.
Note: there have been recent reports (~2022-09-16) that using this bridge may get your account banned.
See the project's documentation to learn what it does and why it might be useful to you.
Prerequisite (optional)
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.
For details about configuring Double Puppeting for this bridge, see the section below: Set 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:
matrix_appservice_kakaotalk_enabled: true
You may optionally wish to add some Additional configuration, or to prepare for double-puppeting before the initial installation.
Additional 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.ymlfor some variables that you can customize via yourvars.ymlfileroles/custom/matrix-bridge-appservice-kakaotalk/templates/config.yaml.j2for the bridge's default configuration. You can override settings (even those that don't have dedicated playbook variables) using thematrix_appservice_kakaotalk_configuration_extension_yamlvariable
Installing
After configuring the playbook, run the installation command:
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
Usage
Start a chat with @kakaotalkbot:example.com (where example.com is your base domain, not the matrix. domain).
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.
💡 Set up Double Puppeting
After successfully enabling bridging, you may wish to set up Double Puppeting (hint: you most likely do).
To set it up, you have 2 ways of going about it.
Method 1: automatically, by enabling Shared Secret Auth
The bridge automatically performs Double Puppeting if Shared Secret Auth service is configured and enabled on the server for this playbook.
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.
Method 2: manually, by asking each user to provide a working access token
When using this method, each user that wishes to enable Double Puppeting needs to follow the following steps:
-
retrieve a Matrix access token for yourself. Refer to the documentation on how to do that.
-
send the access token to the bot. Example:
login-matrix MATRIX_ACCESS_TOKEN_HERE -
make sure you don't log out the
Appservice-Kakaotalkdevice some time in the future, as that would break the Double Puppeting feature