| @@ -9,7 +9,7 @@ For an Integration Manager like [Dimension](https://dimension.t2bot.io) to work, | |||||
| Other important prerequisite is the `dimension.<your-domain>` DNS record being set up correctly. See [Configuring your DNS server](configuring-dns.md) on how to set up DNS record correctly. | Other important prerequisite is the `dimension.<your-domain>` DNS record being set up correctly. See [Configuring your DNS server](configuring-dns.md) on how to set up DNS record correctly. | ||||
| ## Enable | ## Enable | ||||
| [Dimension integrations manager](https://dimension.t2bot.io) installation is disabled by default. You can enable it in your configuration file (`inventory/matrix.<your-domain>/vars.yml`): | |||||
| [Dimension integrations manager](https://dimension.t2bot.io) installation is disabled by default. You can enable it in your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): | |||||
| ```yaml | ```yaml | ||||
| matrix_dimension_enabled: true | matrix_dimension_enabled: true | ||||
| @@ -18,7 +18,7 @@ matrix_dimension_enabled: true | |||||
| ## Define admin users | ## Define admin users | ||||
| These users can modify the integrations this Dimension supports. Admin interface is accessible by opening Dimension in Riot and clicking the settings icon. | These users can modify the integrations this Dimension supports. Admin interface is accessible by opening Dimension in Riot and clicking the settings icon. | ||||
| Add this to your configuration file (`inventory/matrix.<your-domain>/vars.yml`): | |||||
| Add this to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): | |||||
| ```yaml | ```yaml | ||||
| matrix_dimension_admins: ['@user1:domain.com', '@user2:domain.com'] | matrix_dimension_admins: ['@user1:domain.com', '@user2:domain.com'] | ||||
| @@ -37,7 +37,7 @@ To get an access token, follow these steps: | |||||
| **Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.** | **Access tokens are sensitive information. Do not include them in any bug reports, messages, or logs. Do not share the access token with anyone.** | ||||
| Add access token to your configuration file (`inventory/matrix.<your-domain>/vars.yml`): | |||||
| Add access token to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): | |||||
| ```yaml | ```yaml | ||||
| matrix_dimension_access_token: "YOUR ACCESS TOKEN HERE" | matrix_dimension_access_token: "YOUR ACCESS TOKEN HERE" | ||||
| @@ -3,7 +3,7 @@ | |||||
| By default, this playbook would set up a PostgreSQL database server on your machine, running in a Docker container. | By default, this playbook would set up a PostgreSQL database server on your machine, running in a Docker container. | ||||
| If that's alright, you can skip this. | If that's alright, you can skip this. | ||||
| If you'd like to use an external PostgreSQL server that you manage, you can edit your configuration file (`inventory/matrix.<your-domain>/vars.yml`). | |||||
| If you'd like to use an external PostgreSQL server that you manage, you can edit your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`). | |||||
| It should be something like this: | It should be something like this: | ||||
| ```yaml | ```yaml | ||||
| @@ -6,7 +6,7 @@ That is, people on your server can communicate with people on any other Matrix s | |||||
| ## Federating only with select servers | ## Federating only with select servers | ||||
| To make your server only federate with servers of your choosing, add this to your configuration file (`inventory/matrix.<your-domain>/vars.yml`): | |||||
| To make your server only federate with servers of your choosing, add this to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): | |||||
| ```yaml | ```yaml | ||||
| matrix_synapse_federation_domain_whitelist: | matrix_synapse_federation_domain_whitelist: | ||||
| @@ -19,10 +19,10 @@ If you wish to disable federation, you can do that with an empty list (`[]`), or | |||||
| ## Disabling federation | ## Disabling federation | ||||
| To completely disable federation, isolating your server from the rest of the Matrix network, add this to your configuration file (`inventory/matrix.<your-domain>/vars.yml`): | |||||
| To completely disable federation, isolating your server from the rest of the Matrix network, add this to your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`): | |||||
| ```yaml | ```yaml | ||||
| matrix_synapse_federation_enabled: false | matrix_synapse_federation_enabled: false | ||||
| ``` | ``` | ||||
| With that, your server's users will only be able to talk among themselves, but not to anyone who is on another server. | |||||
| With that, your server's users will only be able to talk among themselves, but not to anyone who is on another server. | |||||
| @@ -13,13 +13,13 @@ No matter which external webserver you decide to go with, you'll need to: | |||||
| 1) Make sure your web server user (something like `http`, `apache`, `www-data`, `nginx`) is part of the `matrix` group. You should run something like this: `usermod -a -G matrix nginx` | 1) Make sure your web server user (something like `http`, `apache`, `www-data`, `nginx`) is part of the `matrix` group. You should run something like this: `usermod -a -G matrix nginx` | ||||
| 2) Edit your configuration file (`inventory/matrix.<your-domain>/vars.yml`) to disable the integrated nginx server: | |||||
| 2) Edit your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`) to disable the integrated nginx server: | |||||
| ```yaml | ```yaml | ||||
| matrix_nginx_proxy_enabled: false | matrix_nginx_proxy_enabled: false | ||||
| ``` | ``` | ||||
| 3) **If you'll manage SSL certificates by yourself**, edit your configuration file (`inventory/matrix.<your-domain>/vars.yml`) to disable SSL certificate retrieval: | |||||
| 3) **If you'll manage SSL certificates by yourself**, edit your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`) to disable SSL certificate retrieval: | |||||
| ```yaml | ```yaml | ||||
| matrix_ssl_retrieval_method: none | matrix_ssl_retrieval_method: none | ||||
| @@ -29,7 +29,7 @@ You'll need an Amazon S3 bucket and some IAM user credentials (access key + secr | |||||
| } | } | ||||
| ``` | ``` | ||||
| You then need to enable S3 support in your configuration file (`inventory/matrix.<your-domain>/vars.yml`). | |||||
| You then need to enable S3 support in your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`). | |||||
| It would be something like this: | It would be something like this: | ||||
| ```yaml | ```yaml | ||||
| @@ -6,7 +6,7 @@ This is for when you wish to have your own Apache webserver sitting in front of | |||||
| See the [Using your own webserver, instead of this playbook's nginx proxy](../../docs/configuring-playbook-own-webserver.md) documentation page. | See the [Using your own webserver, instead of this playbook's nginx proxy](../../docs/configuring-playbook-own-webserver.md) documentation page. | ||||
| To use your own Apache reverse-proxy, you first need to disable the integrated nginx server. | To use your own Apache reverse-proxy, you first need to disable the integrated nginx server. | ||||
| You do that with the following custom configuration (`inventory/matrix.<your-domain>/vars.yml`): | |||||
| You do that with the following custom configuration (`inventory/host_vars/matrix.<your-domain>/vars.yml`): | |||||
| ```yaml | ```yaml | ||||
| matrix_nginx_proxy_enabled: false | matrix_nginx_proxy_enabled: false | ||||