README: fix header line length

[dyn-nsupdate.git] / README.rst

diff --git a/README.rst b/README.rst
index 6a4054f989da4df47d3b58aec0df70a8d2c09e00..90bf60ec92d7968615b2b06eba13041ff90a0306 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,14 +1,15 @@
-dyn-nsupdate: Dynamically and securely update DNS zones via CGI
-===============================================================
+dyn-nsupdate: Self-made DynDNS
+==============================
 
 Introduction
 ------------
 
 Welcome to dyn-nsupdate_, a collection of tools using BIND_, CGI_ and Python_ to 
-provide DynDNS services. Both IPv4 and IPv6 are fully supported.
+provide DynDNS services with your own nameserver. Both IPv4 and IPv6 are fully
+supported.
 
 dyn-nsupdate consists of two pieces: The server part provides a way to update IP 
-addresses in Bind's DNS zone via CGI, in a safe manner. The client part uses CGI 
+addresses in Bind's DNS zones via CGI, in a safe manner. The client part uses CGI
 to update some domain to the current address(es) of the machine it is running 
 on. Alternatively, some routers can be configured to do this themselves. The 
 FritzBox is known to be supported.
@@ -38,18 +39,19 @@ source directory, run::
   cd nsupd-wrapper
   mkdir -p build
   cd build
-  cmake .. -DCMAKE_BUILD_TYPE=Release -DDYNNSUPDATE_CONFIG_FILE=/var/lib/bind/dyn-nsupdate.conf
+  DIR=/var/lib/bind
+  cmake .. -DCMAKE_BUILD_TYPE=Release -DDYNNSUPDATE_CONFIG_FILE=$DIR/dyn-nsupdate.conf
   make
 
 This should compile the binary ``dyn-nsupdate``. If you want to put the files in 
 another directory, change the configuration file name accordingly. You can now 
 install it and the sample configuration file, and set their permissions::
 
-  sudo install dyn-nsupdate /var/lib/bind/dyn-nsupdate -o bind -g bind -m +rx,u+ws
-  sudo install ../../dyn-nsupdate.conf /var/lib/bind/dyn-nsupdate.conf -o bind -g bind -m u+rw
+  sudo install dyn-nsupdate $DIR/dyn-nsupdate -o bind -g bind -m +rx,u+ws
+  sudo install ../../dyn-nsupdate.conf.dist $DIR/dyn-nsupdate.conf -o bind -g bind -m u+rw
 
 Finally, edit the config file. The format should be pretty self-explanatory. In 
-particular, *change the password*!
+particular, **change the password**!
 
 Now, let's go on with the CGI scripts. They are using Python 2, so make sure you 
 have that installed. There are two scripts: One is used for clients to detect 
@@ -73,7 +75,9 @@ path in the ``update`` CGI script accordingly.
 That's it! Your server is now configured. You can use ``curl`` to test your 
 setup::
 
-  curl 'https://ns.example.com/update?domain=test.dyn.example.com&password=some_secure_password&ip=127.0.0.1'
+  DOMAIN=test.dyn.example.com
+  PW=some_secure_password
+  curl 'https://ns.example.com/update?domain=$DOMAIN&password=$PW&ip=127.0.0.1'
 
 
 Client setup (using the script)