Browse Source

Merge pull request #623 from merklaw/docimprovements

Python requires docker package and other small improvements
pull/627/head
Slavi Pantaleev 5 years ago
committed by GitHub
parent
commit
238d5e2c78
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 15 additions and 2 deletions
  1. +1
    -1
      docs/configuring-playbook-client-element.md
  2. +11
    -0
      docs/configuring-playbook-ma1sd.md
  3. +2
    -0
      docs/configuring-playbook-ssl-certificates.md
  4. +1
    -1
      roles/matrix-base/defaults/main.yml

+ 1
- 1
docs/configuring-playbook-client-element.md View File

@@ -6,7 +6,7 @@ If that's okay, you can skip this document.


## Disabling Element ## 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.<your-domain>/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.<your-domain>/vars.yml`):


```yaml ```yaml
matrix_client_element_enabled: false matrix_client_element_enabled: false


+ 11
- 0
docs/configuring-playbook-ma1sd.md View File

@@ -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. 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 it if it was previously installed), you can disable it in your configuration file (`inventory/host_vars/matrix.<your-domain>/vars.yml`):

```yaml
matrix_ma1sd_enabled: false
```

## Matrix.org lookup forwarding ## 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). 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).


+ 2
- 0
docs/configuring-playbook-ssl-certificates.md View File

@@ -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 matrix_ssl_retrieval_method: self-signed
``` ```


If you get a `Cannot reach homeserver` error in Element, you will have to visit `https://matrix.<your-domain>` in your browser and agree to the certificate exception before you can login.



## Using your own SSL certificates ## Using your own SSL certificates




+ 1
- 1
roles/matrix-base/defaults/main.yml View File

@@ -85,7 +85,7 @@ matrix_vars_yml_snapshotting_src: "{{ inventory_dir }}/host_vars/{{ inventory_ho
matrix_well_known_matrix_server_enabled: true matrix_well_known_matrix_server_enabled: true


# Controls whether Docker is automatically installed. # 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 matrix_docker_installation_enabled: true


# Controls the Docker package that is installed. # Controls the Docker package that is installed.


Loading…
Cancel
Save