Merge branch 'master' of https://github.com/spantaleev/matrix-docker-ansible-deploy

docs/configuring-playbook-s3.md

@@ -1,9 +1,9 @@
 # Storing Matrix media files on Amazon S3 (optional)
 
-By default, this playbook configures your server to store Matrix Synapse's content repository (`media_store`) files on the local filesystem.
+By default, this playbook configures your server to store Synapse's content repository (`media_store`) files on the local filesystem.
 If that's alright, you can skip this.
 
-If you'd like to store Matrix Synapse's content repository (`media_store`) files on Amazon S3,
+If you'd like to store Synapse's content repository (`media_store`) files on Amazon S3,
 you can let this playbook configure [Goofys](https://github.com/kahing/goofys) for you.
 
 You'll need an Amazon S3 bucket and some IAM user credentials (access key + secret key) with full write access to the bucket. Example security policy:
@@ -36,4 +36,4 @@ matrix_s3_media_store_bucket_name: "your-bucket-name"
 matrix_s3_media_store_aws_access_key: "access-key-goes-here"
 matrix_s3_media_store_aws_secret_key: "secret-key-goes-here"
 matrix_s3_media_store_region: "eu-central-1"
-```
+```

docs/configuring-playbook-turn.md

@@ -0,0 +1,33 @@
+# TURN server
+
+The playbook installs a [Coturn](https://github.com/coturn/coturn) TURN server by default, so that clients can make audio/video calls even from [NAT](https://en.wikipedia.org/wiki/Network_address_translation)-ed networks.
+
+By default, the Synapse chat server is configured, so that it points to the Coturn TURN server installed by the playbook.
+
+
+## Disabling Coturn
+
+If, for some reason, you'd like to prevent the playbook from installing Coturn, you can use the following configuration:
+
+```yaml
+matrix_coturn_enabled: false
+```
+
+In that case, Synapse would not point to any Coturn servers and audio/video call functionality may fail.
+
+
+## Using your own external Coturn server
+
+If you'd like to use another TURN server (be it Coturn or some other one), you can configure the playbook like this:
+
+```yaml
+# Disable integrated Coturn server
+matrix_coturn_enabled: false
+
+# Point Synapse to your other Coturn server
+matrix_synapse_turn_uris:
+- turns:HOSTNAME_OR_IP?transport=udp
+- turns:HOSTNAME_OR_IP?transport=tcp
+- turn:HOSTNAME_OR_IP?transport=udp
+- turn:HOSTNAME_OR_IP?transport=tcp
+```

docs/configuring-playbook.md

@@ -27,11 +27,12 @@ When you're done with all the configuration you'd like to do, continue with [Ins
 
 ## Other configuration options
 
-- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md) (optional)
+### Additional useful services
 
-- [Controlling Matrix federation](configuring-playbook-federation.md) (optional)
+- [Setting up the Dimension Integration Manager](configuring-playbook-dimension.md) (optional, but recommended; after [installing](installing.md))
 
-- [Adjusting email-sending settings](configuring-playbook-email.md) (optional)
+
+### Core service adjustments
 
 - [Storing Matrix media files on Amazon S3](configuring-playbook-s3.md) (optional)
 
@@ -47,6 +48,20 @@ When you're done with all the configuration you'd like to do, continue with [Ins
 
 - [Using your own webserver, instead of this playbook's nginx proxy](configuring-playbook-own-webserver.md) (optional, advanced)
 
+- [Adjusting TURN server configuration](configuring-playbook-turn.md) (optional, advanced)
+
+
+### Server connectivity
+
+- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md) (optional)
+
+- [Controlling Matrix federation](configuring-playbook-federation.md) (optional)
+
+- [Adjusting email-sending settings](configuring-playbook-email.md) (optional)
+
+
+### Authentication and user-related
+
 - [Setting up the REST authentication password provider module](configuring-playbook-rest-auth.md) (optional, advanced)
 
 - [Setting up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md) (optional, advanced)
@@ -55,6 +70,9 @@ When you're done with all the configuration you'd like to do, continue with [Ins
 
 - [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (optional, advanced)
 
+
+### Bridging other networks
+
 - [Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md) (optional)
 
 - [Setting up Mautrix Whatsapp bridging](configuring-playbook-bridge-mautrix-whatsapp.md) (optional)
@@ -62,5 +80,3 @@ When you're done with all the configuration you'd like to do, continue with [Ins
 - [Setting up Appservice IRC bridging](configuring-playbook-bridge-appservice-irc.md) (optional)
 
 - [Setting up Appservice Discord bridging](configuring-playbook-bridge-appservice-discord.md) (optional)
-
-- [Setting up Dimension](configuring-playbook-dimension.md) (optional)

docs/importing-media-store.md

@@ -1,6 +1,6 @@
 # Importing `media_store` data files from an existing installation (optional)
 
-Run this if you'd like to import your `media_store` files from a previous installation of Matrix Synapse.
+Run this if you'd like to import your `media_store` files from a previous installation of Synapse.
 
 
 ## Prerequisites
@@ -19,4 +19,4 @@ Run this command (make sure to replace `<server-path-to-media_store>` with a pat
 
 	ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_media_store=<server-path-to-media_store>' --tags=import-media-store
 
-**Note**: `<server-path-to-media_store>` must be a file path to a `media_store` directory on the server (not on your local machine!).
+**Note**: `<server-path-to-media_store>` must be a file path to a `media_store` directory on the server (not on your local machine!).

docs/importing-postgres.md

@@ -1,6 +1,6 @@
 # Importing an existing Postgres database from another installation (optional)
 
-Run this if you'd like to import your database from a previous installation of Matrix Synapse.
+Run this if you'd like to import your database from a previous installation of Synapse.
 (don't forget to import your `media_store` files as well - see [the importing-media-store guide](importing-media-store.md)).
 
 

docs/importing-sqlite.md

@@ -1,12 +1,12 @@
 # Importing an existing SQLite database from another installation (optional)
 
-Run this if you'd like to import your database from a previous default installation of Matrix Synapse.
+Run this if you'd like to import your database from a previous default installation of Synapse.
 (don't forget to import your `media_store` files as well - see [the importing-media-store guide](importing-media-store.md)).
 
-While this playbook always sets up PostgreSQL, by default a Matrix Synapse installation would run
+While this playbook always sets up PostgreSQL, by default a Synapse installation would run
 using an SQLite database.
 
-If you have such a Matrix Synapse setup and wish to migrate it here (and over to PostgreSQL), this command is for you.
+If you have such a Synapse setup and wish to migrate it here (and over to PostgreSQL), this command is for you.
 
 
 ## Prerequisites
@@ -20,4 +20,4 @@ Run this command (make sure to replace `<server-path-to-homeserver.db>` with a f
 
 	ansible-playbook -i inventory/hosts setup.yml --extra-vars='server_path_homeserver_db=<server-path-to-homeserver.db>' --tags=import-sqlite-db
 
-**Note**: `<server-path-to-homeserver.db>` must be a file path to a `homeserver.db` file on the server (not on your local machine!).
+**Note**: `<server-path-to-homeserver.db>` must be a file path to a `homeserver.db` file on the server (not on your local machine!).