5655473992a78605dfde718b4a9fffec0a44b0d5
[olsrd.git] / lib / nameservice / README
1 ---------------------------------------------------------------------
2 NAMESERVICE PLUGIN FOR OLSRD
3 by Bruno Randolf <bruno.randolf@4g-systems.biz>
4 ---------------------------------------------------------------------
5
6 a simple DNS replacement for OLSR networks
7
8 this plugin distributes host name information over OLSR
9 and writes a file in /etc/hosts format. this file can be 
10 used to resolve hostnames on the local system and/or be
11 read by a DNS server like "dnsmasq", to make the names 
12 available via ordinary DNS to other clients as well.
13
14 the default location of the hosts file is
15 /var/run/hosts_olsr 
16
17
18 ---------------------------------------------------------------------
19 PLUGIN PARAMETERS (PlParam)
20 ---------------------------------------------------------------------
21
22 PlParam "name" "my-name.mesh"
23
24         the name of this OLSR node (main address).
25         can be specified multiple times
26
27 PlParam "IP.ADDR" "another-name.mesh"
28
29         a name for a specified IP address.
30         the IP address has to be either from one of the olsr 
31         interfaces or within a HNA network we announce.
32         can be specified multiple times
33
34 PlParam "filename" "/name/of/hosts_file"
35
36         which file to write to.
37         (default: /var/run/hosts_olsr)
38
39 PlParam "interval" "SEC"
40
41         interval for sending NAME messages in seconds.
42         (default: 120 - 2 minutes)
43
44 PlParam "timeout" "SEC"
45
46         validity time for received NAME messages.
47         (default: 3600 - 1 hour)
48
49 PlParam "suffix" ".olsr"
50
51         local suffix which is appended to all received names
52         (default: "")
53
54
55 ---------------------------------------------------------------------
56 SAMPLE CONFIG
57 ---------------------------------------------------------------------
58
59 add in /etc/olsrd.conf:
60
61 LoadPlugin "olsrd_nameservice.so.0.2"
62 {
63         PlParam "name" "thisismyname.mesh"
64 }
65
66
67 ---------------------------------------------------------------------
68 TODO
69 ---------------------------------------------------------------------
70   
71  * implement a small DNS server into the plugin?
72
73 ---------------------------------------------------------------------
74 EOF / 01.03.2005