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 5. Configure ssh-dyndns as root::
  41
  42     $ cp /usr/local/src/ssh-dyndns/ssh-dyndns.sh.config-dist /etc/ssh-dyndns.sh
  43     $ nano /etc/ssh-dyndns.sh
  44
  45
  46 Configuration
  47 =============
  48 The configuration file template ``ssh-dyndns.sh.config-dist`` may be copied
  49 to either ``/etc/ssh-dyndns.sh`` or ``~/.config/ssh-dyndns.sh``.
  50
  51 The system-wide config file is loaded first, the user-specific one after that.
  52
  53 The configuration file may define the following variables:
  54
  55 ``data_dir``
  56     Path to the tinydns zone files, e.g. ``/etc/tinydns/root/``
  57 ``file_pattern``
  58     File name template. ``%DOMAIN%`` will be replaced with the actual
  59     domain name.
  60
  61     Default: ``data-dyndns-%DOMAIN%``
  62 ``timeout``
  63     DNS entry TTL (time to live) in seconds
  64
  65     Default: 300
  66
  67
  68 =====
  69 Usage
  70 =====
  71 Simply ssh into the server and pass the hostname as parameter::
  72
  73     $ ssh dyndns@example.org home.example.org
  74
  75 This will start the ``ssh-dyndns`` script on the remote server, generate
  76 the tinydns zone file and run ``make`` in the ``data_dir`` directory to
  77 compile the ``data.cdb`` file.
  78 tinydns will automatically pick up the change.
  79
  80
  81 ====
  82 Bugs
  83 ====
  84 - IPv6 is not supported yet
  85
  86
  87 =======
  88 License
  89 =======
  90 ssh-dyndns is licensed under the `AGPL v3`__ or later.
  91
  92 __ http://www.gnu.org/licenses/agpl.html
  93
  94
  95 ======
  96 Author
  97 ======
  98 Written by Christian Weiske, cweiske@cweiske.de