Cleanups
[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   - Secure OLSR plugin. This plugin adds a signature to all messages
25     to ensure data integrity. This way only nodes with access to the
26     shared key can participate in the routing.
27     The key is read as the first 128 bits from /root/.olsr/olsrd_secure_key
28     You need to have the OpenSSL libs installed to use this plugin.
29
30   - Powerplugin. A plugin that uses OLSRs MPR flooding to spread information
31     about the powerstatus of nodes.
32
33   - Dynamic Internet gateway. A plugin that dynamically adds and removes Internet
34     HNA transmissions based on if there exists a default gateway to Internet
35     with hopcount = 0(non OLSR gateway).
36
37   Built in:
38
39   - IPC to GUI front-end. A gui front-end can connect to the daemon
40     if started with the -ipc switch or set in the configfile.
41
42
43 3. COMPILING & INSTALLING
44
45   The makefile is updated in this version.
46   To install to a directoy different from / use INSTALL_PREFIX=targetdir
47   To use other compilers set CC=yourcompiler
48   All this can be done on the command line(or in scripts), so there should
49   not be any need to update the Makefile for different environments.
50
51   These changes also go for the pluginmakefiles.
52
53   To compile:
54   'make OS=targetos'
55
56   To install(you must be root):
57   'make install'
58
59   This also installs the standard configuration file((PREFIXDIR)/etc/olsrd.conf)
60   YOU MUST EDIT THIS FILE!
61
62   To clean up object files run
63   'make clean'
64
65
66   To compile and install the power plugin:
67   cd lib/power
68   make; make install
69
70   To compile and install the dynamic GW plugin:
71   cd lib/dyn_gw
72   make; make install
73
74 4. CONFIGURING & RUNNING:
75
76   OBS!!!!
77   Edit the configuration file to fit your needs.
78
79   Options in the config file can also be overridden by command line 
80   options. See the manual pages olsrd(8) and olsrd.conf(5) for details.
81
82   To run the daemon you MUST specify which interface(s) to use either in
83   the config file or by using the -i option.
84
85   The binary is named 'olsrd' and is installed in (PREFIX)/usr/sbin. 
86   You must have root privelegies to run olsrd!
87
88   To run the daemon in the background you can either start olsrd
89   with the '-d 0' switch or set DEBUG to 0 in the config file.
90
91   To use plugins add them to the configfile as explained in the file.
92
93   4.1 SOME COMMAND-LINE OPTIONS:
94
95   DEPRECATED
96   See the manpage for command line options.
97
98 5. BUGS
99
100   Problems have been reported when running in daemon mode(DEBUG 0). If this
101   causes problems and you need to run olsrd in the background you could
102   just redirect output to /dev/null( > /dev/null)
103
104
105 6. FRONT-END
106
107   These are instructions to build the Linux GTK-based GUI.
108
109   6.1 COMPILING
110
111     To compile:
112     cd linux-gui
113     make
114     The binary is put in the bin directory
115
116   6.2 RUNNING
117
118     To run simply:
119     cd bin
120     ./olsrd-gui
121  
122     REMEMBER olsrd must be started using the -ipc switch or the
123     IPC option must be set to yes to be able to use the GUI front-end
124
125   6.3 BUGS
126