aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: fa5f8fa20e82fa3fd2fc8983b356d67dc8229ce7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
# TinyDNSDyn

This is a basic dynamic server for the djbdns DNS server 'tinydns' by Dan
Bernstein. It enables a client to update its IP address via a simple HTTP based
API.

It should run on any Linux or BSD with Python installed.

## Requirements

* Administrative access to a server running tinydns and hence
  daemontools or similar (such as runit in Void linux)
* Administrative access to a *nix box on you local network
* Python (version 2!) installed on both client and server
* An open port on the server's firewall

## Installation

### Server

1. Copy script and all files onto your server to the daemontools service
   directory (i.e. /etc/tinydnsdyn/)

2. The supplied 'run' script is tailored for debian/ubuntu and may
   need to be changed.

3. You can added dynamic DNS entries to your main data file or alternatively use
   a seperate file for dynamic entries. An existing entry in the tinydns data
   file should already exist. This script will NOT add one. Only those hosts
   listed with prefixes '+' and '=' are able to update their entries.

   For example:

        +groucho.example.com:192.168.0.2:3360
        +groucho.example.com:192.168.0.2
        =groucho.example.com:192.168.0.2:60
        +*.groucho.example.com:192.168.0.2:60
        +*.groucho.example.com:192.168.0.2

   will all get updated if the host groucho.example.com does a request.

4. Create a password file. This is of the format created by Apache's htpasswd
   and consists of one user per line in the following format:

        <username>:<crypted hash>:<optional list of domains>

5. The script will run 'make' in the data directory. This enables you to
   concatenate your data files and whatever else before they are compiled. For
   instance, you may need to combine all your primary and seconary zones and
   then add the dynamic hosts before compiling.

   An example Makefile is included with some ideas.

6. Start the service by symlinking this directory into your svscan directory
   (i.e. "ln $(pwd) /etc/service/" ).

### Client

The service operates over HTTP and should be reasonably close to the service
operated by DynDns.com having the following request format:

http://username:password@yourdnsserver.com/?hostname=yourhostname&myip=optionaladdress

The only required parameter is the hostname you wish to change. This can be a
comma separated list of hostnames to update. The IP address will be determined
automatically if the 'myip' parameter is missing.

The response codes are taken from here (not all of them):

http://www.dyndns.com/developers/specs/return.html

The Python code is basic and inefficient but it should work. I take no
responsibility for anything that may happen to any of your machines.  That
said, please let me know if there are any issues.


### LICENSE

This software is licensed under the MIT License.

Copyright Felix Hanley, 2017.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.