Merge remote-tracking branch 'upstream/master'

docs/configuring-playbook-bridge-mx-puppet-groupme.md

@@ -0,0 +1,38 @@
+# Setting up MX Puppet GroupMe (optional)
+
+The playbook can install and configure
+[mx-puppet-groupme](https://gitlab.com/robintown/mx-puppet-groupme) for you.
+
+See the project page to learn what it does and why it might be useful to you.
+
+To enable the [GroupMe](https://groupme.com/) bridge just use the following
+playbook configuration:
+
+
+```yaml
+matrix_mx_puppet_groupme_enabled: true
+matrix_mx_puppet_groupme_client_id: ""
+matrix_mx_puppet_groupme_client_secret: ""
+```
+
+
+## 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](https://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.

docs/configuring-playbook-synapse.md

@@ -18,6 +18,35 @@ Alternatively, **if there is no pre-defined variable** for a Synapse setting you
 - or, if extending the configuration is still not powerful enough for your needs, you can **override the configuration completely** using `matrix_synapse_configuration` (or `matrix_synapse_configuration_yaml`). You can find information about this in [`roles/matrix-synapse/defaults/main.yml`](../roles/matrix-synapse/defaults/main.yml).
 
 
+## Load balancing with workers
+
+To have Synapse gracefully handle thousands of users, worker support should be enabled. It factors out some homeserver tasks and spreads the load of incoming client and server-to-server traffic between multiple processes. More information can be found in the [official Synapse workers documentation](https://github.com/matrix-org/synapse/blob/master/docs/workers.md).
+
+To enable Synapse worker support, update your `inventory/host_vars/matrix.DOMAIN/vars.yml` file:
+
+```yaml
+matrix_synapse_workers_enabled: true
+```
+
+We support a few configuration presets (`matrix_synapse_workers_preset: one-of-each` being the default configuration):
+- `little-federation-helper` - a very minimal worker configuration to improve federation performance
+- `one-of-each` - one worker of each supported type
+
+If you'd like more customization power, you can start with one of the presets and tweak various `matrix_synapse_workers_*_count` variables manually.
+
+If you increase worker counts too much, you may need to increase the maximum number of Postgres connections too (example):
+
+```yaml
+matrix_postgres_process_extra_arguments: [
+  "-c 'max_connections=200'"
+]
+```
+
+If you're using the default setup (the `matrix-nginx-proxy` webserver being enabled) or you're using your own `nginx` server (which imports the configuration files generated by the playbook), you're good to go. If you use some other webserver, you may need to tweak your reverse-proxy setup manually to forward traffic to the various workers.
+
+In case any problems occur, make sure to have a look at the [list of synapse issues about workers](https://github.com/matrix-org/synapse/issues?q=workers+in%3Atitle) and your `journalctl --unit 'matrix-*'`.
+
+
 ## Synapse Admin
 
 Certain Synapse administration tasks (managing users and rooms, etc.) can be performed via a web user-interace, if you install [Synapse Admin](configuring-playbook-synapse-admin.md).

docs/configuring-playbook.md

@@ -116,6 +116,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins
 
 - [Setting up MX Puppet Discord bridging](configuring-playbook-bridge-mx-puppet-discord.md) (optional)
 
+- [Setting up MX Puppet GroupMe bridging](configuring-playbook-bridge-mx-puppet-groupme.md) (optional)
+
 - [Setting up MX Puppet Steam bridging](configuring-playbook-bridge-mx-puppet-steam.md) (optional)
 
 - [Setting up Email2Matrix](configuring-playbook-email2matrix.md) (optional)

docs/container-images.md

@@ -70,6 +70,8 @@ These services are not part of our default installation, but can be enabled by [
 
 - [sorunome/mx-puppet-discord](https://hub.docker.com/r/sorunome/mx-puppet-discord) - the [mx-puppet-discord](https://github.com/matrix-discord/mx-puppet-discord) bridge to [Discord](https://discordapp.com) (optional)
 
+- [xangelix/mx-puppet-groupme](https://hub.docker.com/r/xangelix/mx-puppet-groupme) - the [mx-puppet-groupme](https://gitlab.com/robintown/mx-puppet-groupme) bridge to [GroupMe](https://groupme.com/) (optional)
+
 - [icewind1991/mx-puppet-steam](https://hub.docker.com/r/icewind1991/mx-puppet-steam) - the [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) bridge to [Steam](https://steampowered.com) (optional)
 
 - [turt2live/matrix-dimension](https://hub.docker.com/r/turt2live/matrix-dimension) - the [Dimension](https://dimension.t2bot.io/) integrations manager (optional)