matrix-docker-ansible-deploy/CHANGELOG.md

# 2018-08-29

## Changing the way SSL certificates are retrieved

We've been using [acmetool](https://github.com/hlandau/acme) (with the [willwill/acme-docker](https://hub.docker.com/r/willwill/acme-docker/) Docker image) until now.

Due to the Docker image being deprecated, and things looking bleak for acmetool's support of the newer ACME v2 API endpoint, we've switched to using [certbot](https://certbot.eff.org/) (with the [certbot/certbot](https://hub.docker.com/r/certbot/certbot/) Docker image).

Simply re-running the playbook will retrieve new certificates (via certbot) for you.
To ensure you don't leave any old files behind, though, you'd better do this:

- `systemctl stop 'matrix*'`
- stop your custom webserver, if you're running one (only affects you if you've installed with `matrix_nginx_proxy_enabled: false`)
- `mv /matrix/ssl /matrix/ssl-acmetool-delete-later`
- re-run the playbook's [installation](docs/installing.md)
- possibly delete `/matrix/ssl-acmetool-delete-later`


# 2018-08-21

## Matrix Corporal support

The playbook can now install and configure [matrix-corporal](https://github.com/devture/matrix-corporal) for you.

Additional details are available in [Setting up Matrix Corporal](docs/configuring-playbook-matrix-corporal.md).


# 2018-08-20

## Matrix Synapse rate limit control variables

The following new variables can now be configured to control Matrix Synapse's rate-limiting (default values are shown below).

```yaml
matrix_synapse_rc_messages_per_second: 0.2
matrix_synapse_rc_message_burst_count: 10.0
```

## Shared Secret Auth support via matrix-synapse-shared-secret-auth

The playbook can now install and configure [matrix-synapse-shared-secret-auth](https://github.com/devture/matrix-synapse-shared-secret-auth) for you.

Additional details are available in [Setting up the Shared Secret Auth password provider module](docs/configuring-playbook-shared-secret-auth.md).


# 2018-08-17

## REST auth support via matrix-synapse-rest-auth

The playbook can now install and configure [matrix-synapse-rest-auth](https://github.com/kamax-io/matrix-synapse-rest-auth) for you.

Additional details are available in [Setting up the REST authentication password provider module](docs/configuring-playbook-rest-auth.md).


## Compression improvements

Shifted Matrix Synapse compression from happening in the Matrix Synapse,
to happening in the nginx proxy that's in front of it.

Additionally, `riot-web` also gets compressed now (in the nginx proxy),
which drops the initial page load's size from 5.31MB to 1.86MB.


## Disabling some unnecessary Synapse services

The following services are not necessary, so they have been disabled:
- on the federation port (8448): the `client` service
- on the http port (8008, exposed over 443): the old Angular `webclient` and the `federation` service

Federation runs only on the federation port (8448) now.
The Client APIs run only on the http port (8008) now.


# 2018-08-15

## mxisd Identity Server support

The playbook now sets up an [mxisd](https://github.com/kamax-io/mxisd) Identity Server for you by default.
Additional details are available in [Adjusting mxisd Identity Server configuration](docs/configuring-playbook-mxisd.md).


# 2018-08-14

## Email-sending support

The playbook now configures an email-sending service (postfix) by default.
Additional details are available in [Adjusting email-sending settings](docs/configuring-playbook-email.md).

With this, Matrix Synapse is able to send email notifications for missed messages, etc.


# 2018-08-08


## (BC Break) Renaming playbook variables

The following playbook variables were renamed:

- from `matrix_max_upload_size_mb` to `matrix_synapse_max_upload_size_mb`
- from `matrix_max_log_file_size_mb` to `matrix_synapse_max_log_file_size_mb`
- from `matrix_max_log_files_count` to `matrix_synapse_max_log_files_count`
- from `docker_matrix_image` to `matrix_docker_image_synapse`
- from `docker_nginx_image` to `matrix_docker_image_nginx`
- from `docker_riot_image` to `matrix_docker_image_riot`
- from `docker_goofys_image` to `matrix_docker_image_goofys`
- from `docker_coturn_image` to `matrix_docker_image_coturn`

If you're overriding any of them in your `vars.yml` file, you'd need to change to the new names.


## Renaming Ansible playbook tag

The command for executing the whole playbook has changed.
The `setup-main` tag got renamed to `setup-all`.


## Docker container linking

Changed the way the Docker containers are linked together. The ones that need to communicate with others operate in a `matrix` network now and not in the default bridge network.
Switch from acmetool to certbot for SSL certificate retrieval 2018-08-29 14:37:44 +08:00			`# 2018-08-29`

			`## Changing the way SSL certificates are retrieved`

			`We've been using [acmetool](https://github.com/hlandau/acme) (with the [willwill/acme-docker](https://hub.docker.com/r/willwill/acme-docker/) Docker image) until now.`

Fix wording 2018-08-29 14:41:24 +08:00			`Due to the Docker image being deprecated, and things looking bleak for acmetool's support of the newer ACME v2 API endpoint, we've switched to using [certbot](https://certbot.eff.org/) (with the [certbot/certbot](https://hub.docker.com/r/certbot/certbot/) Docker image).`
Switch from acmetool to certbot for SSL certificate retrieval 2018-08-29 14:37:44 +08:00
Fix wording 2018-08-29 14:41:24 +08:00			`Simply re-running the playbook will retrieve new certificates (via certbot) for you.`
Switch from acmetool to certbot for SSL certificate retrieval 2018-08-29 14:37:44 +08:00			`To ensure you don't leave any old files behind, though, you'd better do this:`

Fix systemctl command to avoid wildcard expansion 2018-08-29 14:42:59 +08:00			- `systemctl stop 'matrix*'`
Switch from acmetool to certbot for SSL certificate retrieval 2018-08-29 14:37:44 +08:00			- stop your custom webserver, if you're running one (only affects you if you've installed with `matrix_nginx_proxy_enabled: false`)
			- `mv /matrix/ssl /matrix/ssl-acmetool-delete-later`
			`- re-run the playbook's [installation](docs/installing.md)`
			- possibly delete `/matrix/ssl-acmetool-delete-later`


Add support for matrix-corporal 2018-08-21 18:34:34 +08:00			`# 2018-08-21`

			`## Matrix Corporal support`

			`The playbook can now install and configure [matrix-corporal](https://github.com/devture/matrix-corporal) for you.`

			`Additional details are available in [Setting up Matrix Corporal](docs/configuring-playbook-matrix-corporal.md).`


Add controls for influencing Matrix Synapse's rate-limiting 2018-08-21 02:24:54 +08:00			`# 2018-08-20`

			`## Matrix Synapse rate limit control variables`

			`The following new variables can now be configured to control Matrix Synapse's rate-limiting (default values are shown below).`

			```yaml
			`matrix_synapse_rc_messages_per_second: 0.2`
			`matrix_synapse_rc_message_burst_count: 10.0`
			```

			`## Shared Secret Auth support via matrix-synapse-shared-secret-auth`

			`The playbook can now install and configure [matrix-synapse-shared-secret-auth](https://github.com/devture/matrix-synapse-shared-secret-auth) for you.`

Fix broken link in changelog 2018-08-21 02:27:19 +08:00			`Additional details are available in [Setting up the Shared Secret Auth password provider module](docs/configuring-playbook-shared-secret-auth.md).`
Add controls for influencing Matrix Synapse's rate-limiting 2018-08-21 02:24:54 +08:00

Only run federation on 8448 and client on 80 This disables federation on the 80 port, as it's not necessary. We also disable the old Angular webclient. For the federation port (8448), we disable the client APIs as those are not necessary. Those can even cause trouble if one doesn't know about them and thinks that guarding the client APIs at the 80 port is enough. 2018-08-17 12:27:02 +08:00			`# 2018-08-17`

Add matrix-synapse-rest-auth support 2018-08-17 14:02:12 +08:00			`## REST auth support via matrix-synapse-rest-auth`

			`The playbook can now install and configure [matrix-synapse-rest-auth](https://github.com/kamax-io/matrix-synapse-rest-auth) for you.`

			`Additional details are available in [Setting up the REST authentication password provider module](docs/configuring-playbook-rest-auth.md).`


Improve compression support 2018-08-17 13:00:38 +08:00			`## Compression improvements`

			`Shifted Matrix Synapse compression from happening in the Matrix Synapse,`
			`to happening in the nginx proxy that's in front of it.`

			Additionally, `riot-web` also gets compressed now (in the nginx proxy),
			`which drops the initial page load's size from 5.31MB to 1.86MB.`


Only run federation on 8448 and client on 80 This disables federation on the 80 port, as it's not necessary. We also disable the old Angular webclient. For the federation port (8448), we disable the client APIs as those are not necessary. Those can even cause trouble if one doesn't know about them and thinks that guarding the client APIs at the 80 port is enough. 2018-08-17 12:27:02 +08:00			`## Disabling some unnecessary Synapse services`

			`The following services are not necessary, so they have been disabled:`
			- on the federation port (8448): the `client` service
Fix user registration regression Regression since a302a7d7489ec, which made the Matrix Client API only available on the http port (8008) and not over the federation port (8448). 2018-08-17 17:22:05 +08:00			- on the http port (8008, exposed over 443): the old Angular `webclient` and the `federation` service
Only run federation on 8448 and client on 80 This disables federation on the 80 port, as it's not necessary. We also disable the old Angular webclient. For the federation port (8448), we disable the client APIs as those are not necessary. Those can even cause trouble if one doesn't know about them and thinks that guarding the client APIs at the 80 port is enough. 2018-08-17 12:27:02 +08:00
			`Federation runs only on the federation port (8448) now.`
Fix user registration regression Regression since a302a7d7489ec, which made the Matrix Client API only available on the http port (8008) and not over the federation port (8448). 2018-08-17 17:22:05 +08:00			`The Client APIs run only on the http port (8008) now.`
Only run federation on 8448 and client on 80 This disables federation on the 80 port, as it's not necessary. We also disable the old Angular webclient. For the federation port (8448), we disable the client APIs as those are not necessary. Those can even cause trouble if one doesn't know about them and thinks that guarding the client APIs at the 80 port is enough. 2018-08-17 12:27:02 +08:00

Add mxisd Identity Server support 2018-08-15 15:23:22 +08:00			`# 2018-08-15`

			`## mxisd Identity Server support`

			`The playbook now sets up an [mxisd](https://github.com/kamax-io/mxisd) Identity Server for you by default.`
			`Additional details are available in [Adjusting mxisd Identity Server configuration](docs/configuring-playbook-mxisd.md).`


Add email-sending support 2018-08-14 19:11:41 +08:00			`# 2018-08-14`

			`## Email-sending support`

			`The playbook now configures an email-sending service (postfix) by default.`
			`Additional details are available in [Adjusting email-sending settings](docs/configuring-playbook-email.md).`

			`With this, Matrix Synapse is able to send email notifications for missed messages, etc.`


Put all containers in their own isolated Docker network (matrix) Moving away from using the default bridge network to using our own. This isolates our services from other Docker containers running on the default network on the same host. The benefits are that: - isolation is a little better - we no longer share a default bridge network with any other containers that might be running on the host - there are no longer hard dependencies - we do service discovery by DNS name, and not via explicit `--link` usage during container start, so containers can start out of order and fail without bringing down others with them (`matrix-nginx-proxy` can continue running, even if one of the other services dies) In the future, when other services get introduced, the increased resilience and simplicity will help as well. 2018-08-08 13:23:36 +08:00			`# 2018-08-08`


Rename a bunch of playbook variables for better consistency 2018-08-08 14:17:18 +08:00			`## (BC Break) Renaming playbook variables`

			`The following playbook variables were renamed:`

			- from `matrix_max_upload_size_mb` to `matrix_synapse_max_upload_size_mb`
			- from `matrix_max_log_file_size_mb` to `matrix_synapse_max_log_file_size_mb`
			- from `matrix_max_log_files_count` to `matrix_synapse_max_log_files_count`
			- from `docker_matrix_image` to `matrix_docker_image_synapse`
			- from `docker_nginx_image` to `matrix_docker_image_nginx`
			- from `docker_riot_image` to `matrix_docker_image_riot`
			- from `docker_goofys_image` to `matrix_docker_image_goofys`
			- from `docker_coturn_image` to `matrix_docker_image_coturn`

			If you're overriding any of them in your `vars.yml` file, you'd need to change to the new names.


Rename Ansible playbook tag (setup-main -> setup-all) 2018-08-08 14:03:37 +08:00			`## Renaming Ansible playbook tag`

			`The command for executing the whole playbook has changed.`
			The `setup-main` tag got renamed to `setup-all`.


Put all containers in their own isolated Docker network (matrix) Moving away from using the default bridge network to using our own. This isolates our services from other Docker containers running on the default network on the same host. The benefits are that: - isolation is a little better - we no longer share a default bridge network with any other containers that might be running on the host - there are no longer hard dependencies - we do service discovery by DNS name, and not via explicit `--link` usage during container start, so containers can start out of order and fail without bringing down others with them (`matrix-nginx-proxy` can continue running, even if one of the other services dies) In the future, when other services get introduced, the increased resilience and simplicity will help as well. 2018-08-08 13:23:36 +08:00			`## Docker container linking`

Add controls for influencing Matrix Synapse's rate-limiting 2018-08-21 02:24:54 +08:00			Changed the way the Docker containers are linked together. The ones that need to communicate with others operate in a `matrix` network now and not in the default bridge network.