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.5 KiB
Setting up Mautrix Hangouts bridging (optional, deprecated)
Note: This bridge has been deprecated in favor of Google Chat bridge, which can be installed using this playbook. Consider using that bridge instead of this one.
The playbook can install and configure mautrix-hangouts for you.
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 Google Hangouts bridge, add the following configuration to your inventory/host_vars/matrix.example.com/vars.yml file:
matrix_mautrix_hangouts_enabled: true
Installing
After configuring the playbook, run the installation command: just install-all or just setup-all
Usage
Once the bot is enabled you need to start a chat with Hangouts bridge bot with handle @hangoutsbot:example.com (where example.com is your base domain, not the matrix. domain).
Send login to the bridge bot to receive a link to the portal from which you can enable the bridging. Open the link sent by the bot and follow the instructions.
Automatic login may not work. If it does not, reload the page and select the "Manual login" checkbox before starting. Manual login involves logging into your Google account normally and then manually getting the OAuth token from browser cookies with developer tools.
Once logged in, recent chats should show up as new conversations automatically. Other chats will get portals as you receive messages.
You can learn more about authentication from the bridge's official documentation on Authentication.
💡 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
Mautrix-Hangoutsdevice some time in the future, as that would break the Double Puppeting feature