You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
59 lines
3.0 KiB
59 lines
3.0 KiB
3 years ago
|
# Setting up Mautrix Hangouts (optional)
|
||
|
|
|
||
|
|
The playbook can install and configure [mautrix-hangouts](https://github.com/tulir/mautrix-hangouts) for you.
|
||
|
|
|
||
|
|
See the project's [documentation](https://github.com/tulir/mautrix-hangouts/wiki#usage) to learn what it does and why it might be useful to you.
|
||
|
|
|
||
|
|
To enable the [Google Hangouts](https://hangouts.google.com/) bridge just use the following playbook configuration:
|
||
|
|
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
matrix_mautrix_hangouts_enabled: true
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## Set up Double Puppeting
|
||
|
|
|
||
|
|
If you'd like to use [Double Puppeting](https://github.com/tulir/mautrix-hangouts/wiki/Authentication#double-puppeting) (hint: you most likely do), you have 2 ways of going about it.
|
||
|
|
|
||
|
|
### Method 1: automatically, by enabling Shared Secret Auth
|
||
|
|
|
||
|
|
The bridge will automatically perform Double Puppeting if you enable [Shared Secret Auth](configuring-playbook-shared-secret-auth.md) 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
|
||
|
|
|
||
|
|
**Note**: This method for enabling Double Puppeting can be configured only after you've already set up bridging (see [Usage](#usage)).
|
||
|
|
|
||
|
|
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. You can use the following command:
|
||
|
|
|
||
|
|
```
|
||
|
|
curl \
|
||
|
|
--data '{"identifier": {"type": "m.id.user", "user": "YOUR_MATRIX_USERNAME" }, "password": "YOUR_MATRIX_PASSWORD", "type": "m.login.password", "device_id": "Mautrix-Hangouts", "initial_device_display_name": "Mautrix-Hangouts"}' \
|
||
|
|
https://matrix.DOMAIN/_matrix/client/r0/login
|
||
|
|
```
|
||
|
|
|
||
|
|
- send the access token to the bot. Example: `login-matrix MATRIX_ACCESS_TOKEN_HERE`
|
||
|
|
|
||
|
|
- make sure you don't log out the `Mautrix-Hangouts` device some time in the future, as that would break the Double Puppeting feature
|
||
|
|
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Once the bot is enabled you need to start a chat with `Hangouts bridge bot` with handle `@hangoutsbot:YOUR_DOMAIN` (where `YOUR_DOMAIN` 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](https://github.com/tulir/mautrix-hangouts/wiki/Authentication).
|
||
|
|
|
||
|
|
After successfully enabling bridging, you may wish to [set up Double Puppeting](#set-up-double-puppeting), if you haven't already done so.
|
||
|
|
|