README.rst

   1 **********
   2 ssh-dyndns
   3 **********
   4 Update DNS records by simply SSH'ing into a server.
   5
   6 The idea is to create a separate "dyndns" user on the DNS server.
   7 It gets the ``ssh-dyndns`` script as login shell, so that no other programs
   8 may be executed.
   9 SSH provides secure, password-less key-based authentication.
  10
  11 Upon login, the remote IP is used to create/update a tinydns file with the
  12 DNS record for a hostname given by the SSH client.
  13
  14 tinydns is part of the dbjdns/dbndns package.
  15
  16
  17 =====
  18 Setup
  19 =====
  20
  21 1. Clone ssh-dyndns into a sensible location, e.g. ``/usr/local/src/ssh-dyndns``::
  22
  23     $ cd /usr/local/src/ && git clone git://git.cweiske.de/ssh-dyndns.git
  24
  25 2. Create a user with ``ssh-dyndns`` as login shell::
  26
  27     $ useradd -g nogroup -m -N -s /usr/local/src/ssh-dyndns dyndns
  28
  29 3. Setup password-less ssh keys for the dyndns user::
  30
  31     $ su - dyndns -s /bin/bash
  32     $ mkdir ~/.ssh
  33     $ cat /path/to/key.pub >> ~/.ssh/authorized_keys
  34
  35 4. Prevent showing login messages::
  36
  37     $ su - dyndns -s /bin/bash
  38     $ touch ~/.hushlogin
  39
  40    Alternatively, you may commend out the "motd" lines in ``/etc/pam.d/sshd``
  41 5. Configure ssh-dyndns as root::
  42
  43     $ cp /usr/local/src/ssh-dyndns/ssh-dyndns.sh.config-dist /etc/ssh-dyndns.sh
  44     $ nano /etc/ssh-dyndns.sh
  45
  46
  47 Configuration
  48 =============
  49 The configuration file template ``ssh-dyndns.sh.config-dist`` may be copied
  50 to either ``/etc/ssh-dyndns.sh`` or ``~/.config/ssh-dyndns.sh``.
  51
  52 The system-wide config file is loaded first, the user-specific one after that.
  53
  54 The configuration file may define the following variables:
  55
  56 ``data_dir``
  57     Path to the tinydns zone files, e.g. ``/etc/tinydns/root/``
  58 ``file_pattern``
  59     File name template. ``%DOMAIN%`` will be replaced with the actual
  60     domain name.
  61
  62     Default: ``data-dyndns-%DOMAIN%``
  63 ``timeout``
  64     DNS entry TTL (time to live) in seconds
  65
  66     Default: 300
  67 ``domain_patterns``
  68     Defines patterns for domains that may be dynamically changed.
  69     If the domain name does not match the pattern, the script aborts.
  70
  71     You may use several patterns by separating them with a space.
  72     Shell wildcards are supported (``*`` and ``?``).
  73
  74     Default: ``home.example.org *.home.example.org``
  75
  76
  77 =====
  78 Usage
  79 =====
  80 Simply ssh into the server and pass the hostname as parameter::
  81
  82     $ ssh dyndns@example.org home.example.org
  83
  84 This will start the ``ssh-dyndns`` script on the remote server, generate
  85 the tinydns zone file and run ``make`` in the ``data_dir`` directory to
  86 compile the ``data.cdb`` file.
  87 tinydns will automatically pick up the change.
  88
  89
  90 ====
  91 Bugs
  92 ====
  93 - IPv6 is not supported yet
  94
  95
  96 =======
  97 License
  98 =======
  99 ssh-dyndns is licensed under the `AGPL v3`__ or later.
 100
 101 __ http://www.gnu.org/licenses/agpl.html
 102
 103
 104 ======
 105 Author
 106 ======
 107 Written by Christian Weiske, cweiske@cweiske.de