From f57b2f6e925d9797a03f2fc3dc72c9b50705a20d Mon Sep 17 00:00:00 2001 From: merklaw Date: Wed, 5 Aug 2020 12:45:44 +0200 Subject: [PATCH 1/8] Better wording --- docs/configuring-playbook-client-element.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-client-element.md b/docs/configuring-playbook-client-element.md index 265363643..c53bb4440 100644 --- a/docs/configuring-playbook-client-element.md +++ b/docs/configuring-playbook-client-element.md @@ -6,7 +6,7 @@ If that's okay, you can skip this document. ## Disabling Element -If you'd like for the playbook to not install (or to uninstall the previously installed Element), you can disable it in your configuration file (`inventory/host_vars/matrix./vars.yml`): +If you'd like for the playbook to not install Element (or to uninstall the previously installed Element), you can disable it in your configuration file (`inventory/host_vars/matrix./vars.yml`): ```yaml matrix_client_element_enabled: false From e167b80f94a69284fd8e2ad55abf66b7fcfdb1ba Mon Sep 17 00:00:00 2001 From: merklaw Date: Wed, 5 Aug 2020 12:46:30 +0200 Subject: [PATCH 2/8] Added notes about disabling ma1sd --- docs/configuring-playbook-ma1sd.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/configuring-playbook-ma1sd.md b/docs/configuring-playbook-ma1sd.md index aca858f2b..a25db89b3 100644 --- a/docs/configuring-playbook-ma1sd.md +++ b/docs/configuring-playbook-ma1sd.md @@ -6,6 +6,17 @@ This server is private by default, potentially at the expense of user discoverab ma1sd is a fork of [mxisd](https://github.com/kamax-io/mxisd) which was pronounced end of life 2019-06-21. + +## Disabling ma1sd + +ma1sd, being an Identity Server, is not strictly needed. It is only used for 3PIDs (3rd party identifiers like E-mail and phone numbers) and some [enhanced features](https://github.com/ma1uta/ma1sd/#features). + +If you'd like for the playbook to not install ma1sd (or to uninstall the previously installed ma1sd), you can disable it in your configuration file (`inventory/host_vars/matrix./vars.yml`): + +```yaml +matrix_ma1sd_enabled: false +``` + ## Matrix.org lookup forwarding To ensure maximum discovery, you can make your identity server also forward lookups to the central matrix.org Identity server (at the cost of potentially leaking all your contacts information). From 205c15a80bbf1823ccca05a98b2c88f07718a58d Mon Sep 17 00:00:00 2001 From: merklaw Date: Wed, 5 Aug 2020 12:47:32 +0200 Subject: [PATCH 3/8] Add note about certificate exceptions when using self-signed --- docs/configuring-playbook-ssl-certificates.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/configuring-playbook-ssl-certificates.md b/docs/configuring-playbook-ssl-certificates.md index 0b593f201..916f6838b 100644 --- a/docs/configuring-playbook-ssl-certificates.md +++ b/docs/configuring-playbook-ssl-certificates.md @@ -28,6 +28,8 @@ If self-signed certificates are alright with you, you can ask the playbook to ge matrix_ssl_retrieval_method: self-signed ``` +If you get a `Cannot reach homeserver` error in Element, you will have to visit `https://matrix.` in your browser and agree to the certificate exception before you can login. + ## Using your own SSL certificates From 0cd243095d3e4ea963a26ccf103a1d4a02f5dd6a Mon Sep 17 00:00:00 2001 From: merklaw Date: Wed, 5 Aug 2020 12:49:40 +0200 Subject: [PATCH 4/8] The docker package is a requirement and was not previously mentioned --- docs/prerequisites.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/prerequisites.md b/docs/prerequisites.md index 5f551eb43..1ea9b6396 100644 --- a/docs/prerequisites.md +++ b/docs/prerequisites.md @@ -4,7 +4,7 @@ - `root` access to your server (or a user capable of elevating to `root` via `sudo`). -- [Python](https://www.python.org/) being installed on the server. Most distributions install Python by default, but some don't (e.g. Ubuntu 18.04) and require manual installation (something like `apt-get install python`). +- [Python](https://www.python.org/) and the [`docker`](https://pypi.org/project/docker/) package (requires [`pip`](https://packaging.python.org/guides/installing-using-linux-tools/)) being installed on the server. Most distributions install Python by default, but some don't (e.g. Ubuntu 18.04) and require manual installation (something like `apt-get install python`). - A `cron`-like tool installed on the server such as `cron` or `anacron` to automatically schedule the Let's Encrypt SSL certificates's renewal. *This can be ignored if you use your own SSL certificates.* From a460420b34ecdbc2f47f0224066a9d663fbb5a61 Mon Sep 17 00:00:00 2001 From: merklaw Date: Wed, 5 Aug 2020 15:59:52 +0200 Subject: [PATCH 5/8] Better wording --- docs/configuring-playbook-client-element.md | 2 +- docs/configuring-playbook-ma1sd.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuring-playbook-client-element.md b/docs/configuring-playbook-client-element.md index c53bb4440..8b0eb331f 100644 --- a/docs/configuring-playbook-client-element.md +++ b/docs/configuring-playbook-client-element.md @@ -6,7 +6,7 @@ If that's okay, you can skip this document. ## Disabling Element -If you'd like for the playbook to not install Element (or to uninstall the previously installed Element), you can disable it in your configuration file (`inventory/host_vars/matrix./vars.yml`): +If you'd like for the playbook to not install Element (or to uninstall it if it was previously installed), you can disable it in your configuration file (`inventory/host_vars/matrix./vars.yml`): ```yaml matrix_client_element_enabled: false diff --git a/docs/configuring-playbook-ma1sd.md b/docs/configuring-playbook-ma1sd.md index a25db89b3..03208337f 100644 --- a/docs/configuring-playbook-ma1sd.md +++ b/docs/configuring-playbook-ma1sd.md @@ -11,7 +11,7 @@ ma1sd is a fork of [mxisd](https://github.com/kamax-io/mxisd) which was pronounc ma1sd, being an Identity Server, is not strictly needed. It is only used for 3PIDs (3rd party identifiers like E-mail and phone numbers) and some [enhanced features](https://github.com/ma1uta/ma1sd/#features). -If you'd like for the playbook to not install ma1sd (or to uninstall the previously installed ma1sd), you can disable it in your configuration file (`inventory/host_vars/matrix./vars.yml`): +If you'd like for the playbook to not install ma1sd (or to uninstall it if it was previously installed), you can disable it in your configuration file (`inventory/host_vars/matrix./vars.yml`): ```yaml matrix_ma1sd_enabled: false From 48b93091f9cde37721e53cc7beea93b5bb952d18 Mon Sep 17 00:00:00 2001 From: merklaw Date: Wed, 5 Aug 2020 16:38:39 +0200 Subject: [PATCH 6/8] Revert notes about the docker package being needed --- docs/prerequisites.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/prerequisites.md b/docs/prerequisites.md index 1ea9b6396..5f551eb43 100644 --- a/docs/prerequisites.md +++ b/docs/prerequisites.md @@ -4,7 +4,7 @@ - `root` access to your server (or a user capable of elevating to `root` via `sudo`). -- [Python](https://www.python.org/) and the [`docker`](https://pypi.org/project/docker/) package (requires [`pip`](https://packaging.python.org/guides/installing-using-linux-tools/)) being installed on the server. Most distributions install Python by default, but some don't (e.g. Ubuntu 18.04) and require manual installation (something like `apt-get install python`). +- [Python](https://www.python.org/) being installed on the server. Most distributions install Python by default, but some don't (e.g. Ubuntu 18.04) and require manual installation (something like `apt-get install python`). - A `cron`-like tool installed on the server such as `cron` or `anacron` to automatically schedule the Let's Encrypt SSL certificates's renewal. *This can be ignored if you use your own SSL certificates.* From 87df15441c92abfbaa8092391a89c74c9404db43 Mon Sep 17 00:00:00 2001 From: merklaw Date: Wed, 5 Aug 2020 17:31:16 +0200 Subject: [PATCH 7/8] Add note about installilng 'docker' Python package if Docker installation is disabled --- roles/matrix-base/defaults/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/matrix-base/defaults/main.yml b/roles/matrix-base/defaults/main.yml index 520f36f13..8e4c8079e 100644 --- a/roles/matrix-base/defaults/main.yml +++ b/roles/matrix-base/defaults/main.yml @@ -85,7 +85,7 @@ matrix_vars_yml_snapshotting_src: "{{ inventory_dir }}/host_vars/{{ inventory_ho matrix_well_known_matrix_server_enabled: true # Controls whether Docker is automatically installed. -# If you change this to false you must install and update Docker manually. +# If you change this to false you must install and update Docker manually. You also need to install the [`docker`](https://pypi.org/project/docker/) Python package. matrix_docker_installation_enabled: true # Controls the Docker package that is installed. From fa6d85636f77e15d531b0ff70354f30e1d2edc5e Mon Sep 17 00:00:00 2001 From: merklaw Date: Wed, 5 Aug 2020 17:35:25 +0200 Subject: [PATCH 8/8] Add note about installing 'docker' Python package if Docker installation is disabled --- roles/matrix-base/defaults/main.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/roles/matrix-base/defaults/main.yml b/roles/matrix-base/defaults/main.yml index 8e4c8079e..9ab8bb3ce 100644 --- a/roles/matrix-base/defaults/main.yml +++ b/roles/matrix-base/defaults/main.yml @@ -85,7 +85,7 @@ matrix_vars_yml_snapshotting_src: "{{ inventory_dir }}/host_vars/{{ inventory_ho matrix_well_known_matrix_server_enabled: true # Controls whether Docker is automatically installed. -# If you change this to false you must install and update Docker manually. You also need to install the [`docker`](https://pypi.org/project/docker/) Python package. +# If you change this to false you must install and update Docker manually. You also need to install the docker (https://pypi.org/project/docker/) Python package. matrix_docker_installation_enabled: true # Controls the Docker package that is installed.