summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJason D. McCormick <jason@mfamily.org>2022-11-26 13:58:06 -0500
committerJason D. McCormick <jason@mfamily.org>2022-11-26 13:58:06 -0500
commitb5d846201758164dbe90e7c55cb77608fba2853e (patch)
tree222d4d6e6163f36323529b8a60228bf57906cc38
parent1dac29e7416dfc9490dbc435fadfc8188c2279e3 (diff)
update configuration information
-rw-r--r--README.md41
1 files changed, 22 insertions, 19 deletions
diff --git a/README.md b/README.md
index 4c4e6a0..2136937 100644
--- a/README.md
+++ b/README.md
@@ -13,16 +13,17 @@ For Debian/Ubuntu systems: apt install python3-dns python3-urllib3
For Fedora systems: dnf install python3-dns python3-urllib3
# Configuration
-The only configuration file/item is if you want to use the file
-/etc/he-dns-secret to contain the key for authenticating to
-dns.he.net. Otherwise, you can provide it on the command line with the
-**-s** option.
+Unless using the ``--key`` argument, keys for the dyanmic record
+are read from ``/etc/he-dyndns.conf`` or from an alternative
+location specified by ``--keyfile``. The configuration file
+format is one section [keys] with record = key pairs. For example:
-The **/etc/he-dns-secret** file is sourced into the Bash environment by the
-script. It can contain any shell code that can execute when being called with
-a "source" function. The only key thing that matters is that the variable
-CODE is defined by the script. Since this file will be sourced into the
-program, ensure proper security is applied to this file.
+```
+[keys]
+dynamic.example.com = 123412341234
+```
+
+Other configuration sections will be ignored.
# Usage
```
@@ -31,18 +32,20 @@ usage: he-dyndns [-h] [--v4] [--v6] [--addr4 ADDR4] [--addr6 ADDR6] [--key KEY]
Update Hurricane Electric DNS dynamic record
positional arguments:
- record DNS record to update
+ record DNS record to update
optional arguments:
- -h, --help show this help message and exit
- --v4 Update IPv4 A record (default)
- --v6 Update IPv6 AAAA record
- --addr4 ADDR4 Update A record with provided IP rather than detected IP
- --addr6 ADDR6 Update AAAA record with provided IP rather than detected IP
- --key KEY HE DDNS key for record (by default read from /etc/he-dns-secret)
- --debug Enable debug logging
+ -h, --help show this help message and exit
+ --v4 Update IPv4 A record (default)
+ --v6 Update IPv6 AAAA record
+ --addr4 ADDR4 Update A record with provided IP rather than detected IP
+ --addr6 ADDR6 Update AAAA record with provided IP rather than detected IP
+ --keyfile KEYFILE Alternate location for key config file (default /etc/he-dns-secret.conf)
+ --key KEY HE DDNS key for record (by default read from /etc/he-dns-secret.conf or --keyfile)
+ --debug Enable debug logging
+
```
# Return Values
-Returns 0 on success or 1 on failure. Failures also
-include a single line error message.
+Returns 0 on success (successful change or no change) or 1 on failure.
+Failures also include a single line error message.