Update docs for DNS settings etc. (#3936)
* Update docs for DNS settings of the services which need its CNAME record by default - Buscarron - Go-NEB; fix a line on the instruction as well - wsproxy - Cinny - Element Web - Hydrogen - SchildiChat Web - Dimension - Etherpad - Jitsi - ntfy - Grafana - rageshake - Sygnal Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for DNS settings of the services which do not need its CNAME record by default - matrix-alertmanager-receiver - Honoroit - maubot - Heisenbridge - Cactus Comments - Matrix Authentication Service - matrix-registration - Sliding Sync proxy - Synapse Admin - synapse-usage-exporter Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for DNS settings: ma1sd Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for DNS settings: Email2Matrix Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for DNS settings: Postmoogle Remove the table from configuring-dns.md altogether Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs for Cinny and Dimension: adopt the common note Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Update docs/configuring-dns.md: add "Note" to the line on using Cloudflare DNS Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> --------- Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
@ -9,6 +9,12 @@ If you'd like to stop the playbook installing the client, see the section [below
|
||||
- [app.element.io](https://app.element.io/), hosted by [Element](https://element.io/)
|
||||
- [app.etke.cc](https://app.etke.cc/), hosted by [etke.cc](https://etke.cc/)
|
||||
|
||||
## Adjusting DNS records
|
||||
|
||||
By default, this playbook installs Element Web on the `element.` subdomain (`element.example.com`) and requires you to create a CNAME record for `element`, which targets `matrix.example.com`.
|
||||
|
||||
When setting, replace `example.com` with your own.
|
||||
|
||||
## Adjusting the playbook configuration
|
||||
|
||||
### Themes
|
||||
@ -40,9 +46,7 @@ If you define your own themes with it and set `matrix_client_element_themes_enab
|
||||
|
||||
If you make your own theme, we encourage you to submit it to the **aaronraimist/element-themes** project, so that the whole community could easily enjoy it.
|
||||
|
||||
### Adjusting the Element Web URL
|
||||
|
||||
By default, this playbook installs Element Web on the `element.` subdomain (`element.example.com`) and requires you to [adjust your DNS records](#adjusting-dns-records).
|
||||
### Adjusting the Element Web URL (optional)
|
||||
|
||||
By tweaking the `matrix_client_element_hostname` and `matrix_client_element_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one.
|
||||
|
||||
@ -57,6 +61,10 @@ matrix_client_element_hostname: "{{ matrix_server_fqn_matrix }}"
|
||||
matrix_client_element_path_prefix: /element
|
||||
```
|
||||
|
||||
After changing the domain, **you may need to adjust your DNS** records to point the Element domain to the Matrix server.
|
||||
|
||||
If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration.
|
||||
|
||||
### Extending the configuration
|
||||
|
||||
There are some additional things you may wish to configure about the component.
|
||||
@ -84,14 +92,6 @@ matrix_client_element_configuration_extension_json: |
|
||||
}
|
||||
```
|
||||
|
||||
## Adjusting DNS records
|
||||
|
||||
Once you've decided on the domain and path, **you may need to adjust your DNS** records to point the Element Web domain to the Matrix server.
|
||||
|
||||
By default, you will need to create a CNAME record for `element`. See [Configuring DNS](configuring-dns.md) for details about DNS changes.
|
||||
|
||||
If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration.
|
||||
|
||||
## Disabling Element Web
|
||||
|
||||
If you'd like for the playbook to not install Element Web (or to uninstall it if it was previously installed), add the following configuration to your `vars.yml` file:
|
||||
|
Reference in New Issue
Block a user