From b5edaf8b1b5d4b104612dbca6c01be23245bdc8a Mon Sep 17 00:00:00 2001
From: Michael Steenbeek <42928941+MichaelDeciso@users.noreply.github.com>
Date: Tue, 26 Feb 2019 22:06:40 +0100
Subject: [PATCH] Write page about Dynamic DNS (#145)
---
source/manual.rst | 1 +
source/manual/dynamic_dns.rst | 65 +++++++++++++++++++++++++++++++++++
2 files changed, 66 insertions(+)
create mode 100644 source/manual/dynamic_dns.rst
diff --git a/source/manual.rst b/source/manual.rst
index 771daec6..c12ea874 100644
--- a/source/manual.rst
+++ b/source/manual.rst
@@ -43,4 +43,5 @@ User Manual
manual/diagnostics
manual/monit
manual/nptv6
+ manual/dynamic_dns
manual/howtos
diff --git a/source/manual/dynamic_dns.rst b/source/manual/dynamic_dns.rst
new file mode 100644
index 00000000..7292d94b
--- /dev/null
+++ b/source/manual/dynamic_dns.rst
@@ -0,0 +1,65 @@
+.. |br| raw:: html
+
+
+
+===========
+Dynamic DNS
+===========
+
+Normally, a hostname is tied to a fixed IP address. This works well if the server the hostname is used for has a
+static IP address. However, a static IP address is not always an option. In order to tie a hostname to a dynamic
+IP address, a Dynamic DNS service can be used.
+
+-------------------------------
+Setting up a dynamic IP address
+-------------------------------
+
+In the web interface, go to :menuselection:`Services --> Dynamic DNS`. In the upper right corner, click **Add**.
+
+A form will now appear with the following fields:
+
+======================= =======================================================================================================================================================================
+ Field Explanation
+======================= =======================================================================================================================================================================
+ Enable Enable this rule (allows turning entries off without removing them).
+ Service type The provider of your Dynamic DNS Service. If you use one not in the list, select “Custom” or “Custom (v6)”.
+ Interface to monitor This will usually be WAN.
+ Hostname Enter the complete host/domain name. For example: *myhost.dyndns.org*
+ MX Set this option only if you need a special MX record. Not all services support this. Note: with a dynamic DNS service you can only use a hostname, not an IP address.
+ Wildcards Enable Wildcard
+ Verbose logging Enable verbose logging
+ Username Username is required for all types except Namecheap, FreeDNS and Custom Entries.
+ Password
+ Description A description to easily identify this rule in the overview.
+======================= =======================================================================================================================================================================
+
+If you select “Custom” or “Custom (v6)” under “Service type”, more fields will appear:
+
+=============================== =============================================================================================================================================================================================================================
+ Field Explanation
+=============================== =============================================================================================================================================================================================================================
+ Interface to send update from Most likely to be the same as “Interface to monitor”.
+ CURL options Options passed to the ``curl`` command. These include `Verify SSL peer `_ and `Force IPv4 resolving `_.
+ Update URL An URL to let the Dynamic DNS provider know your IP address has changed. See the “full help” for information on how to use it.
+ Result Match Can be used to verify the reply from the server, in order to distinguish confirmations from errors. See the “full help” for information on how to use it.
+=============================== =============================================================================================================================================================================================================================
+
+^^^^^^^^^^^^^^^^^^^^^^
+Provider-specific info
+^^^^^^^^^^^^^^^^^^^^^^
+
++------------------------------+------------------------------------------------------------------------------------------+
+| Provider | Specifics |
++==============================+==========================================================================================+
+| Custom / Custom (v6) | Username and Password fields represent HTTP Basic Authentication username and passwords. |
++------------------------------+------------------------------------------------------------------------------------------+
+| Duck DNS | Username field: Enter your Token. |br| |
+| | Password field: Leave empty. |
++------------------------------+------------------------------------------------------------------------------------------+
+| FreeDNS (freedns.afraid.org) | Password field: Enter your “Authentication Token”. |
++------------------------------+------------------------------------------------------------------------------------------+
+| he.net tunnelbroker | Hostname field: Enter your “Tunnel ID”.
++------------------------------+------------------------------------------------------------------------------------------+
+| Route 53 | Username field: Enter your “Access Key ID”. |br| |
+| | Password field: Enter your “Secret Access Key”. |
++------------------------------+------------------------------------------------------------------------------------------+