Add debian build folder to OLSRd. Create a debian package just with "dpkg-buildpackag...
[olsrd.git] / debian / README.Debian
1 olsrd for Debian
2 ----------------
3
4
5 Configuration
6 -------------
7
8 Before running olsrd you must edit the default configuration file
9 /etc/olsrd/olsrd.conf (the location differs in the debian package from the 
10 upstream default /etc/olsrd.conf). The one change you must make is to define
11 on which interfaces olsrd is supposed to act on.
12
13 If you want, you can run olsrd via init.d by editing /etc/default/olsrd - the
14 default configuration is to not start olsrd on boot. It needs root privileges
15 to run olsrd. 
16
17 To debug olsrd you can start it with "/etc/init.d/olsrd start debug".
18
19 You also need to configure your network interface. For example, for 
20 freifunk.hamburg.net the following settings are used:
21
22         ifconfig eth1 $YOUR_IP broadcast 10.127.255.255
23         iwconfig eth1 essid hamburg.freifunk.net channel 10 mode ad-hoc enc off
24
25 Options in the olsrd config file can also be overridden by command line
26 options or in /etc/default/olsrd. See the manual pages olsrd(8) and 
27 olsrd.conf(5) for details.
28
29 If debug level is set to 0 olsrd will detach and run in the background (this 
30 is the default in the debian package), if not it will keep running in your 
31 shell.
32
33
34 Plugins
35 -------
36
37 The following plugins are included in the olsrd-plugins package and are 
38 explained in detail in /usr/share/doc/olsrd-plugins:
39
40 - httpinfo      - tiny webserver for information purposes 
41 - dyn_gw        - dynamically announce uplinks
42 - dot_draw      - generates output (over a TCP socket) in the dot format
43 - secure        - secure OLSR routing with a shared key
44 - nameservice   - announce hostnames and dns servers
45 - bmf           - basic multicast forwarding plugin for olsrd
46 - txtinfo
47
48 The following plugins are not included in the olsrd-plugins binary package:
49
50 - quagga        - quagga plugin
51 - tas           - (not at all) tiny application server, no useful apps exist
52 - powerinfo     - displays /proc/apm on 127.0.0.1:8888
53 - pgraph        - obsoleted by httpinfo and dot-draw
54 - mini          - minimal example plugin, useful as a howto for writing plugins
55
56 If you need them, you can easily build them from the debian source package 
57 yourself: define which (additional) plugins you want in debian/rules, and 
58 rebuild the package. And if you tell me a good reason why they should be 
59 included in the binary package, I'll be glad to add them :)
60
61
62 About this package
63 ------------------
64
65 This is actually the unik-olsrd implementation, but because it's the only 
66 commonly used one (the other two, nrl- and inria-olsrd are mostly used 
67 where they were written) and the one found on www.olsr.org, so I decided to 
68 call the package olsrd.
69
70 The config file shipped in /etc/olsrd/olsrd.conf is based on the one from
71 http://olsrexperiment.de/sven-ola/nylon/packages/olsrd/files/olsrd.conf-sven-ola 
72 and has been successfully used in the freifunk networks in Berlin and Hamburg
73 (Germany).
74
75 The plugins are installed in /usr/lib/olsrd/ which differs from the upstream 
76 default /usr/lib/.
77
78
79  -- Holger Levsen <holger@debian.org>  Tue,  8 Jul 2008 18:09:15 +0200