add sudo rules, fix dyndns user creation

[ssh-dyndns.git] / README.rst

diff --git a/README.rst b/README.rst
index 9956dd3ac9238de820ecff86a765d8b03a53f2b9..002b0116e556e92a36c949b200bfbcef171bdd0d 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -24,7 +24,7 @@ Setup
 
 2. Create a user with ``ssh-dyndns`` as login shell::
 
-    $ useradd -g nogroup -m -N -s /usr/local/src/ssh-dyndns dyndns
+    $ useradd -g nogroup -m -N -s /usr/local/src/ssh-dyndns/ssh-dyndns dyndns
 
 3. Setup password-less ssh keys for the dyndns user::
 
@@ -37,11 +37,17 @@ Setup
     $ su - dyndns -s /bin/bash
     $ touch ~/.hushlogin
 
+   Alternatively, you may commend out the "motd" lines in ``/etc/pam.d/sshd``
 5. Configure ssh-dyndns as root::
 
     $ cp /usr/local/src/ssh-dyndns/ssh-dyndns.sh.config-dist /etc/ssh-dyndns.sh
     $ nano /etc/ssh-dyndns.sh
 
+6. Allow ssh-dyndns to run "sudo make" without password::
+
+    $ visudo
+    dyndns  ALL= NOPASSWD: /usr/bin/make
+
 
 Configuration
 =============
@@ -63,6 +69,14 @@ The configuration file may define the following variables:
     DNS entry TTL (time to live) in seconds
 
     Default: 300
+``domain_patterns``
+    Defines patterns for domains that may be dynamically changed.
+    If the domain name does not match the pattern, the script aborts.
+
+    You may use several patterns by separating them with a space.
+    Shell wildcards are supported (``*`` and ``?``).
+
+    Default: ``home.example.org *.home.example.org``
 
 
 =====