From bf0fa1408e9838f45e668e92f5c7731b44b8fb95 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 27 Oct 2024 16:47:10 +0900 Subject: [PATCH] Add ddclient to documentation - Update README.md - Update docs/configuring-playbook-dynamic-dns.md: remove reference to deceased Google Domains etc. - Update docs/configuring-playbook.md: move documentation to server connectivity section - Update docs/container-images.md: add linuxserver/ddclient Signed-off-by: Suguru Hirahara --- README.md | 1 + docs/configuring-playbook-dynamic-dns.md | 19 +++++++++++++------ docs/configuring-playbook.md | 4 ++-- docs/container-images.md | 2 ++ 4 files changed, 18 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 4936d750b..381d35d56 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,7 @@ Services that run on the server to make the various parts of your installation w | [ma1sd](https://github.com/ma1uta/ma1sd) | x | Matrix Identity Server | [Link](docs/configuring-playbook-ma1sd.md) | [Exim](https://www.exim.org/) | ✓ | Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server) | [Link](docs/configuring-playbook-email.md) | | [Dimension](https://github.com/turt2live/matrix-dimension) | x | An open source integration manager for Matrix clients | [Link](docs/configuring-playbook-dimension.md) | +| [ddclient](https://github.com/linuxserver/docker-ddclient) | x | Dynamic DNS | [Link](docs/configuring-playbook-dynamic-dns.md) | | [Sygnal](https://github.com/matrix-org/sygnal) | x | Push gateway | [Link](docs/configuring-playbook-sygnal.md) | | [ntfy](https://ntfy.sh) | x | Push notifications server | [Link](docs/configuring-playbook-ntfy.md) | diff --git a/docs/configuring-playbook-dynamic-dns.md b/docs/configuring-playbook-dynamic-dns.md index 573987c84..efabb75b9 100644 --- a/docs/configuring-playbook-dynamic-dns.md +++ b/docs/configuring-playbook-dynamic-dns.md @@ -1,24 +1,31 @@ # Setting up Dynamic DNS (optional) -## Setup +The playbook can configure Dynamic DNS with [ddclient⁠](https://github.com/ddclient/ddclient) for you. It is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider. Most cloud providers / ISPs will charge you extra for a static IP address. If you're not hosting a highly reliable homeserver you can workaround this via dynamic DNS. -To set this up, you'll need to get the username/password from your DNS provider. For google domains, this process is described [here](https://support.google.com/domains/answer/6147083). +## Prerequisite -After you've gotten the proper credentials you can add the following config to your `inventory/host_vars/matrix.example.com/vars.yml`: +You'll need to get a username and password from your DNS provider. Please consult with the provider about how to retrieve them. + +## Adjusting the playbook configuration + +To enable dynamic DNS, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: ```yaml matrix_dynamic_dns_enabled: true matrix_dynamic_dns_domain_configurations: - - provider: domains.google.com + - provider: example.net protocol: dyndn2 - username: XXXXXXXXXXXXXXXX - password: XXXXXXXXXXXXXXXX + username: YOUR_USERNAME_HERE + password: YOUR_PASSWORD_HERE domain: "{{ matrix_domain }}" ``` +## Installing + +After configuring the playbook, run the [installation](installing.md) command: `just install-all` or `just setup-all` ## Additional Reading diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 09068124c..839993480 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -37,8 +37,6 @@ When you're done with all the configuration you'd like to do, continue with [Ins - [Setting up Etherpad](configuring-playbook-etherpad.md) (optional) -- [Setting up Dynamic DNS](configuring-playbook-dynamic-dns.md) (optional) - - [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md) (optional) - [Enabling metrics and graphs for NginX logs](docs/configuring-playbook-prometheus-nginxlog.md) (optional) @@ -81,6 +79,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins - [Adjusting email-sending settings](configuring-playbook-email.md) (optional) +- [Setting up Dynamic DNS](configuring-playbook-dynamic-dns.md) (optional) + - [Setting up Hydrogen](configuring-playbook-client-hydrogen.md) - a new lightweight Matrix client with legacy and mobile browser support (optional) - [Setting up Cinny](configuring-playbook-client-cinny.md) - a web client focusing primarily on simple, elegant and secure interface (optional) diff --git a/docs/container-images.md b/docs/container-images.md index fea54299c..9cb916687 100644 --- a/docs/container-images.md +++ b/docs/container-images.md @@ -94,6 +94,8 @@ These services are not part of our default installation, but can be enabled by [ - [turt2live/matrix-dimension](https://hub.docker.com/r/turt2live/matrix-dimension) - the [Dimension](https://dimension.t2bot.io/) integration manager (optional) +- [linuxserver/ddclient](https://hub.docker.com/r/linuxserver/ddclient) - [ddclient](https://github.com/linuxserver/docker-ddclient) used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider (optional) + - [jitsi/web](https://hub.docker.com/r/jitsi/web) - the [Jitsi](https://jitsi.org/) web UI (optional) - [jitsi/jicofo](https://hub.docker.com/r/jitsi/jicofo) - the [Jitsi](https://jitsi.org/) Focus component (optional)