Browse Source

docs/configuring-playbook-ipv6.md -> docs/configuring-ipv6.md

pull/4156/head
Slavi Pantaleev 1 year ago
parent
commit
ce90df519e
6 changed files with 7 additions and 7 deletions
  1. +2
    -2
      CHANGELOG.md
  2. +1
    -1
      docs/configuring-dns.md
  3. +1
    -1
      docs/configuring-ipv6.md
  4. +1
    -1
      docs/configuring-playbook.md
  5. +1
    -1
      docs/quick-start.md
  6. +1
    -1
      examples/vars.yml

+ 2
- 2
CHANGELOG.md View File

@@ -4,7 +4,7 @@


Our [default example configuration](./examples/vars.yml) and [Configuring DNS](./docs/configuring-dns.md) guides now recommend enabling [IPv6](https://en.wikipedia.org/wiki/IPv6) support. We recommend that everyone enables IPv6 support for their Matrix server, even if they don't have IPv6 connectivity yet. Our [default example configuration](./examples/vars.yml) and [Configuring DNS](./docs/configuring-dns.md) guides now recommend enabling [IPv6](https://en.wikipedia.org/wiki/IPv6) support. We recommend that everyone enables IPv6 support for their Matrix server, even if they don't have IPv6 connectivity yet.


Our new [Configuring IPv6](./docs/configuring-playbook-ipv6.md) documentation page has more details about the playbook's IPv6 support.
Our new [Configuring IPv6](./docs/configuring-ipv6.md) documentation page has more details about the playbook's IPv6 support.


**Existing playbook users** will **need to do some manual work** to enable IPv6 support. This consists of: **Existing playbook users** will **need to do some manual work** to enable IPv6 support. This consists of:


@@ -14,7 +14,7 @@ Our new [Configuring IPv6](./docs/configuring-playbook-ipv6.md) documentation pa
- delete all container networks on the server: `docker network rm $(docker network ls -q)` - delete all container networks on the server: `docker network rm $(docker network ls -q)`
- re-run the playbook fully: `just install-all` - re-run the playbook fully: `just install-all`


- [configuring IPv6 (`AAAA`) DNS records](./docs/configuring-playbook-ipv6.md#configuring-dns-records-for-ipv6)
- [configuring IPv6 (`AAAA`) DNS records](./docs/configuring-ipv6.md#configuring-dns-records-for-ipv6)


# 2025-02-26 # 2025-02-26




+ 1
- 1
docs/configuring-dns.md View File

@@ -33,7 +33,7 @@ To serve the base domain (`example.com`) and [Element Web](configuring-playbook-


As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IPv4/IPv6 address. As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IPv4/IPv6 address.


If you don't have IPv6 connectivity yet, you can skip the `AAAA` record. For more details about IPv6, see the [Configuring IPv6](./configuring-playbook-ipv6.md) documentation page.
If you don't have IPv6 connectivity yet, you can skip the `AAAA` record. For more details about IPv6, see the [Configuring IPv6](./configuring-ipv6.md) documentation page.


The `element.example.com` subdomain is necessary, because this playbook installs the [Element Web](https://github.com/element-hq/element-web) client for you by default. If you'd rather instruct the playbook not to install Element Web (`matrix_client_element_enabled: false` when [Configuring the playbook](configuring-playbook.md) later), feel free to skip the `element.example.com` DNS record. The `element.example.com` subdomain is necessary, because this playbook installs the [Element Web](https://github.com/element-hq/element-web) client for you by default. If you'd rather instruct the playbook not to install Element Web (`matrix_client_element_enabled: false` when [Configuring the playbook](configuring-playbook.md) later), feel free to skip the `element.example.com` DNS record.




docs/configuring-playbook-ipv6.md → docs/configuring-ipv6.md View File

@@ -43,7 +43,7 @@ You can enable IPv6 support for all components' Docker container networks by usi
# #
# People managing Docker themselves and running an older Docker version will need additional configuration. # People managing Docker themselves and running an older Docker version will need additional configuration.
# #
# Learn more in `docs/configuring-playbook-ipv6.md`.
# Learn more in `docs/configuring-ipv6.md`.
devture_systemd_docker_base_ipv6_enabled: true devture_systemd_docker_base_ipv6_enabled: true
``` ```



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

@@ -77,7 +77,7 @@ For a more custom setup, see the [Other configuration options](#other-configurat


- [Controlling Matrix federation](configuring-playbook-federation.md) - [Controlling Matrix federation](configuring-playbook-federation.md)


- [Configuring IPv6](./configuring-playbook-ipv6.md)
- [Configuring IPv6](./configuring-ipv6.md)


### Clients ### Clients




+ 1
- 1
docs/quick-start.md View File

@@ -57,7 +57,7 @@ To configure Matrix services in the default settings, go to your DNS service pro


As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IPv4/IPv6 address. As the table illustrates, you need to create 2 subdomains (`matrix.example.com` and `element.example.com`) and point both of them to your server's IPv4/IPv6 address.


If you don't have IPv6 connectivity yet, you can skip the `AAAA` record. For more details about IPv6, see the [Configuring IPv6](./configuring-playbook-ipv6.md) documentation page.
If you don't have IPv6 connectivity yet, you can skip the `AAAA` record. For more details about IPv6, see the [Configuring IPv6](./configuring-ipv6.md) documentation page.


It might take some time for the DNS records to propagate after creation. It might take some time for the DNS records to propagate after creation.




+ 1
- 1
examples/vars.yml View File

@@ -42,7 +42,7 @@ matrix_playbook_reverse_proxy_type: playbook-managed-traefik
# #
# People managing Docker themselves and running an older Docker version will need additional configuration. # People managing Docker themselves and running an older Docker version will need additional configuration.
# #
# Learn more in `docs/configuring-playbook-ipv6.md`.
# Learn more in `docs/configuring-ipv6.md`.
devture_systemd_docker_base_ipv6_enabled: true devture_systemd_docker_base_ipv6_enabled: true


# A Postgres password to use for the superuser Postgres user (called `matrix` by default). # A Postgres password to use for the superuser Postgres user (called `matrix` by default).


Loading…
Cancel
Save