don't hard-code the path to the python interpreter
[dyn-nsupdate.git] / README.rst
index b9a2043be3276a70e734e090fecea69a81b9171b..1102b2d673874c0fad6c135dc37a17a906eadab1 100644 (file)
@@ -33,7 +33,7 @@ the passwords, and applies the updates; and some CGI scripts offered through a
 webserver. Please read this guide carefully and make sure you understand the
 security implications of what you are doing. setuid wrappers are not toys!
 
-Let's setting up the setuid wrapper. To compile it, you will need cmake and 
+Let's first set up the setuid wrapper. To compile it, you will need cmake and 
 boost, including the regex and program_options boost packages. Starting in the 
 source directory, run::
 
@@ -49,7 +49,7 @@ configuration file will be hard-coded into the binary. If it were run-time
 configurable, then a user could call the script with her own configuration file, 
 gaining access to all domains BIND lets you configure. If you want to put the 
 files in another directory, change the configuration file name accordingly. Make 
-sure the file (nor any of the directories it is in) can *not be written by 
+sure the file (and all of the directories it is in) can *not be written by 
 non-root*. The setuid wrapper trusts that file. You can now install it and the 
 sample configuration file, and set their permissions::
 
@@ -97,7 +97,7 @@ Python 3. Copy that script to the machine that should be available under the
 dynamic domain. Also copy the sample configuration file 
 ``dyn-ns-client.conf.dist`` to ``$HOME/.config/dyn-nsupdate/dyn-ns-client.conf``.
 You can choose another name, but then you will have to tell the script about it. 
-Call "dyn-ns-client --help" for this and other options the script accepts. An 
+Call ``dyn-ns-client --help`` for this and other options the script accepts. An 
 important aspect of configuration is how to detect the current addresses of the 
 machine the script is running on. For IPv4, this can only be "web", which can 
 deal with NAT. For IPv6, the script can alternatively attempt to detect the 
@@ -137,10 +137,13 @@ Note that the user name is ignored.
 Source, License
 ---------------
 
-You can find the sources in the `git repository`_. They are provided under a 
-2-clause BSD license.
+You can find the sources in the `git repository`_ (also available `on GitHub`_). 
+They are provided under a `2-clause BSD license`_. See the file ``LICENSE-BSD`` 
+for more details.
 
 .. _git repository: http://www.ralfj.de/git/dyn-nsupdate.git
+.. _on GitHub: https://github.com/RalfJung/dyn-nsupdate
+.. _2-clause BSD license: http://opensource.org/licenses/bsd-license.php
 
 Contact
 -------