Skip to content
This repository has been archived by the owner on Jun 30, 2021. It is now read-only.
Karmanyaah Malhotra edited this page Mar 3, 2021 · 2 revisions

Welcome to the matrix-groupme-go wiki!

This bridge is still in a very early stage, obligatory - do not use for production workloads.

Use

  1. Invite @groupmebot:example.com (replacing example.com with your homeserver)
  2. Type help
  3. Get your access token from https://dev.groupme.com/
  4. The first thing that needs to be done from that list of commands is login <access token from step 3>

Install

To install, download the binary, easiest at this point, copy the example config into config.yaml, and fill out the appropriate values.

The following instructions are derived from and very similar to mautrix-whatsapp:

  1. Copy example-config.yaml (from git) to config.yaml
  2. Update the config to your liking.
    • You need to make sure that the address and domain field point to your homeserver.
    • You will also need to add your user of admin user under the permissions section.
  3. Generate the appservice registration file by running ./matrix-groupme-go -g.
    • You can use the -c and -r flags to change the location of the config and registration files. They default to config.yaml and registration.yaml respectively.
  4. Add the path to the registration file (registration.yaml by default) to your synapse homeserver.yaml under app_service_config_files. You will then need to restart the synapse server. Remember to restart it every time the registration file is regenerated.
  5. Run the bridge with ./matrix-groupme-go.

Compile

Clone this repo and

  • <github.com/karmanyaahm/groupme> into ../groupme
  • <github.com/karmanyaahm/mautrix-go> into ../mautrix The build scripts don't work yet, just use go build.

Compiling from scratch is not tested/supported at the moment since the bridge is very much in alpha state.

Note

See the ROADMAP.md file for missing features, don't open issues about things unchecked there unless the situation is appropriate.

Clone this wiki locally