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