From b9a73eab6cd15d7b770e64602301966041e148d6 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Thu, 3 Oct 2013 15:37:36 +0200 Subject: [PATCH] configuration help: add some generic intro text, improve / clarify wording, reorder --- .../main/templates/main/generate_secret.html | 2 +- nsupdate/main/templates/main/help.html | 2 +- .../includes/tabbed_router_configuration.html | 52 ++++++++++++------- 3 files changed, 36 insertions(+), 20 deletions(-) diff --git a/nsupdate/main/templates/main/generate_secret.html b/nsupdate/main/templates/main/generate_secret.html index 4d0e65f..9af77e3 100644 --- a/nsupdate/main/templates/main/generate_secret.html +++ b/nsupdate/main/templates/main/generate_secret.html @@ -13,7 +13,7 @@
-

How to configure your router?

+

How to configure automated dynamic DNS updates?

{% include "main/includes/tabbed_router_configuration.html" with host=object %}
diff --git a/nsupdate/main/templates/main/help.html b/nsupdate/main/templates/main/help.html index 8e14cd1..f6c5c03 100644 --- a/nsupdate/main/templates/main/help.html +++ b/nsupdate/main/templates/main/help.html @@ -21,7 +21,7 @@
-

How to configure your router?

+

How to configure automated dynamic DNS updates?

{% include "main/includes/tabbed_router_configuration.html" with host=object %}
diff --git a/nsupdate/main/templates/main/includes/tabbed_router_configuration.html b/nsupdate/main/templates/main/includes/tabbed_router_configuration.html index f7b3ceb..0733b8a 100644 --- a/nsupdate/main/templates/main/includes/tabbed_router_configuration.html +++ b/nsupdate/main/templates/main/includes/tabbed_router_configuration.html @@ -8,8 +8,20 @@

General configuration hints

+

+ Usually, you should configure one system on your network to update the DNS. + This can be either your router or a host on your network and it will run some software + called the update client. +

+

+ We have some specific configuration hints for some devices and update clients, + please see the tabs above. If you don't find yours there, use the generic hints below. +

- Your router/script needs to call the following URL for IPv4 updates: +

+ Your update client needs to access the following URLs to update the DNS: +

+ For IPv4 updates:
http://{{ host.get_fqdn|default:"<your fqdn>" }}:{{ update_secret|default:"<your secret>" }}@ipv4.nsupdate.info/nic/update
@@ -17,35 +29,39 @@
http://{{ host.get_fqdn|default:'<your fqdn>' }}:{{ update_secret|default:'<your secret>' }}@ipv6.nsupdate.info/nic/update
- The IPs will be determined automatically. + The IPs will be determined automatically using the remote address our service is seeing + (see below for more details).
- Briefly your router/script has to do the following steps: +

+ Your update client has to do the following steps: +

    -
  • visit http://ipv4.nsupdate.info/nic/update (to update A (IPv4) record)
    • -
  • visit http://ipv6.nsupdate.info/nic/update (to update AAAA (IPv6) record)
  • Do HTTP Basic Auth with:
    • Username: {{ host.get_fqdn|default:"<your fqdn>" }}
    • Password: {{ update_secret|default:"<your secret>" }}
    • -
  • The response will look like this: +
  • Send a http GET request to:
      -
    • "good <your ip>" new IP accepted
      • -
    • "nochg <your ip>" IP accepted, but did not change since last update
      • -
    • Code 401: Authorization Required Incorrect or no authentication data
      • +
    • http://ipv4.nsupdate.info/nic/update (to update IPv4 A record in DNS)
      • +
    • http://ipv6.nsupdate.info/nic/update (to update IPv6 AAAA record in DNS)
      • +
    • We support http on port 80 (and soon also https on port 443).
    • -
- For routers or other dyndns2 compatible clients: -
    -
  • They must send a http basic auth header with hostname / yoursecret.
    • -
  • They must send a GET request to our server: nsupdate.info, path: /nic/update
    • -
  • We support http on port 80 (and soon also https on port 443).
    • -
  • URL args (all are optional): +
  • Optionally, we support some URL arguments:
      -
    • myip=127.0.0.1 or myip=::1 (if not given: autodetect from remote_addr)
      • -
    • hostname=hostname (if not given: autodetect from http basic auth)
      • +
    • myip=127.0.0.1 or myip=::1 (by default, we autodetect the IP. If the autodetected IP is not + the one you want to put into DNS, you need to give the wanted one explicitly using myip=...) +
      • +
    • hostname={{ host.get_fqdn|default:"<your fqdn>" }} (if not given: autodetect from http basic auth)
      • +
    +
    • +
  • The response status and content will be: +
      +
    • Status 200 and "good <your ip>" new IP accepted
      • +
    • Status 200 and "nochg <your ip>" IP accepted, but did not change since last update
      • +
    • Status 401: Authorization Required Incorrect authentication or no http basic auth header received