If the registry cannot be found, do not bother.
[olsrd.git] / README
1
2 olsr.org OLSR daemon 0.4.8
3
4 Andreas Tonnesen(andreto@olsr.org)
5 Thomas Lopatic  (thomas@lopatic.de)
6
7 http://www.olsr.org
8
9 nn.11.04
10
11
12 1. OLSR RFC COMPLIANCE
13
14   Olsrd is RFC3626 compliant. Most RFC realted definitions can be found 
15   in the olsr_protocol header file.
16
17
18 2. EXTENTIONS
19
20   This version also has some extentions which are part of other projects:
21
22   Plugins:
23
24   - Dynamic Internet gateway. A plugin that dynamically adds and removes Internet
25     HNA transmissions based on if there exists a default gateway to Internet
26     with hopcount = 0(non OLSR gateway).
27
28   - Dot draw. A plugin that produces output in the dot format representing
29     the network topology.
30
31   - Secure OLSR plugin. This plugin adds a signature to all messages
32     to ensure data integrity. This way only nodes with access to the
33     shared key can participate in the routing.
34     You need to have the OpenSSL libs installed to use this plugin.
35
36   - Powerplugin. A plugin that uses OLSRs MPR flooding to spread information
37     about the powerstatus of nodes. Ment as an example plugin to get coders
38     started.
39
40   Built in:
41
42   - IPC to GUI front-end. A gui front-end can connect to the daemon
43     if started with the -ipc switch or set in the configfile.
44
45
46 3. COMPILING & INSTALLING
47
48   The makefile is updated in this version.
49   To install to a directoy different from / use INSTALL_PREFIX=targetdir
50   To use other compilers set CC=yourcompiler
51   All this can be done on the command line(or in scripts), so there should
52   not be any need to update the Makefile for different environments.
53
54   These changes also go for the pluginmakefiles.
55
56   To compile:
57   'make OS=targetos'
58   Just type 'make' to see a list of available targets.
59
60   To install(you must be root):
61   'make install'
62
63   This also installs the standard configuration file((PREFIXDIR)/etc/olsrd.conf)
64   YOU MUST EDIT THIS FILE!
65
66   To clean up object files run
67   'make clean'
68
69
70   To compile and install the power plugin:
71   cd lib/power
72   make; make install
73
74   To compile and install the dynamic GW plugin:
75   cd lib/dyn_gw
76   make; make install
77
78 4. CONFIGURING & RUNNING:
79
80   OBS!!!!
81   Edit the configuration file to fit your needs.
82
83   Options in the config file can also be overridden by command line 
84   options. See the manual pages olsrd(8) and olsrd.conf(5) for details.
85
86   To run the daemon you MUST specify which interface(s) to use either in
87   the config file or by using the -i option.
88
89   The binary is named 'olsrd' and is installed in (PREFIX)/usr/sbin. 
90   You must have root privelegies to run olsrd!
91
92   To run the daemon in the background you can either start olsrd
93   with the '-d 0' switch or set DEBUG to 0 in the config file.
94
95   To use plugins add them to the configfile as explained in the file.
96
97   4.1 SOME COMMAND-LINE OPTIONS:
98
99   DEPRECATED
100   See the manpage for command line options.
101
102 5. BUGS
103
104   Problems have been reported when running in daemon mode(DEBUG 0). If this
105   causes problems and you need to run olsrd in the background you could
106   just redirect output to /dev/null( > /dev/null)
107
108
109 6. FRONT-END
110
111   These are instructions to build the Linux GTK-based GUI.
112
113   6.1 COMPILING
114
115     To compile:
116     cd linux-gui
117     make
118     The binary is put in the bin directory
119
120   6.2 RUNNING
121
122     To run simply:
123     cd bin
124     ./olsrd-gui
125  
126     REMEMBER olsrd must be started using the -ipc switch or the
127     IPC option must be set to yes to be able to use the GUI front-end
128
129   6.3 BUGS
130