matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-mx-puppet-groupme.md
Suguru Hirahara 282e8be07d
Use common sentences on documentation regarding installation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-13 03:38:48 +09:00

1.3 KiB

Setting up MX Puppet GroupMe (optional)

The playbook can install and configure mx-puppet-groupme for you.

See the project page to learn what it does and why it might be useful to you.

Adjusting the playbook configuration

To enable the GroupMe bridge, add the following configuration to your inventory/host_vars/matrix.DOMAIN/vars.yml file:

matrix_mx_puppet_groupme_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 GroupMe Puppet Bridge with the handle @_groupmepuppet_bot:YOUR_DOMAIN (where YOUR_DOMAIN is your base domain, not the matrix. domain).

One authentication method is available.

To link your GroupMe account, go to dev.groupme.com, sign in, and select "Access Token" from the top menu. Copy the token and message the bridge with:

link <access token>

Once logged in, send listrooms to the bot user to list the available rooms.

Clicking rooms in the list will result in you receiving an invitation to the bridged room.

Also send help to the bot to see the commands available.