* renamed the various REAMEs more consistently
[olsrd.git] / lib / quagga / README_QUAGGA
1 ---------------------------------------------------------------------
2 QUAGGA PLUGIN FOR OLSRD
3 by Immo 'FaUl' Wehrenberg <immo@chaostreff-dortmund.de>
4 ---------------------------------------------------------------------
5
6 This is the Quagga Plugin for the OLSRD. 
7 It allowes olsrd to redistribute from various quagga-protocols 
8 as well as to export olsr-routes to quagga so that they can be
9 redistributed by the quagga-routing-daemons.
10
11 Note Sven-Ola: You also need a source distribution of quagga-0.98.5
12 or quagga-0.98.6 (that is the current stable). The quagga source tree 
13 needs to be patched with quagga-0.98.6-olsr.diff, compiled and installed
14 via 'make install'. Because many people will otherwise have compile
15 probs, I've added 2 include files in lib/quagga/src/quagga. If you
16 want to use another version of quagga, make sure to remove these
17 before you compile the olsrd_quagga plugin.
18
19 ---------------------------------------------------------------------
20 PLUGIN PARAMETERS (PlParam)
21 ---------------------------------------------------------------------
22
23 PlParam "redistribute" "<protocol>"
24         where protocol is one of the following:
25         system, kernel, connect, static, rip, ripng, ospf, ospf6,
26         isis, bgp, hsls
27         May be used more then once
28
29 PlParam "ExportRoutes" "<only/both>"
30         exportes olsr-routes to quagga or to both, quagga and kernel
31         no routes are exportet if not set.
32
33 PlParam "LocalPref" "true"
34         sets the zebra SELECTED-flag on the routes exported to zebra
35         which means these routes are prefered in any case.
36
37 PlParam "Distance" "0-255"
38         allowes to set Administrative distance to routes exported 
39         to zebra.
40         
41 ---------------------------------------------------------------------
42 SAMPLE CONFIG
43 ---------------------------------------------------------------------
44
45 add in /etc/olsrd.conf:
46
47 LoadPlugin "olsrd_quagga.so.0.2.2"
48 {
49         PlParam "redistribute" "ospf"
50         PlParam "redistribute" "bgp"
51         PlParam "ExportRoutes" "only"
52         PlParam "Distance" "125" 
53         PlParam "LocalPref" "false"
54 }
55
56
57 ---------------------------------------------------------------------
58 EOF / 8.5.2006