merge with http://gredler.at/hg/olsrd
[olsrd.git] / lib / httpinfo / README_HTTPINFO
1 HTTP MINI-SERVER PLUGIN FOR OLSRD 0.1
2 by Andreas T√łnnesen(andreto@olsr.org)
3
4 -----------------------------------------------------
5
6  ABOUT
7
8 This plugin implements a tiny HTTP server that
9 will gespond to a GET request by returning a HTML
10 formatted page contanin various information about
11 the currently running olsrd process.
12 This information includes detailed link status for
13 all links and neighbors, all olsrd routes in the 
14 kernel, local configuration, uptime and more. The
15 plugin can also generate a olsrd configfile based
16 on current running configuration.
17 In adittion an experimental administrtion interface
18 is available.
19
20 -----------------------------------------------------
21
22  PARAMETERS
23
24 The plugin takes the parameter "Port" "[portnumber]" 
25 to set the TCP port on which the server is to run. 
26 It defaults to 1978.
27 Now remember to open this port in your firewall if 
28 planning to access the HTTP server from a remote host!
29 The parameter "Host" "[IP address]" is used to allow
30 access from a single host(muliple such entries can
31 be set) and the parameter "Net" "[IP net] [IP mask]"
32 is used to allow access from entire net-ranges.
33 To allow access from all hosts do:
34  PlParam   "Net" "0.0.0.0 0.0.0.0"
35
36 A configuration example:
37 LoadPlugin "olsrd_httpinfo.so.0.1"
38 {
39     PlParam     "port"   "80"
40     PlParam     "Host"   "163.24.87.3"
41     PlParam     "Host"   "80.23.53.22"
42     PlParam     "Net"    "10.0.0.0 255.0.0.0"
43     PlParam     "Net"    "192.168.0.0 255.255.0.0"
44 }
45
46 This will run the webserver on port 80(the normal
47 HTTP port) and allow access from the hosts 163.24.87.3
48 and 80.23.53.22 and the networks 10.0.0.0/8 and
49 192.168.0.0/16.
50 access is always allowed from 127.0.0.1(localhost).
51
52 -----------------------------------------------------
53
54  EXPERIMENTAL ADMIN INTERFACE
55
56 The plugin can be compiled with a experimental 
57 adminitrator interface. This is a web page that will
58 let the user change olsrd settings in realtime.
59 To compile with this feature pass ADMIN_INTERFACE=1
60 as an argument to make(eg. make ADMIN_INTERFACE=1)
61
62 -----------------------------------------------------
63
64 NOTE!
65 This plugin is very olsrd version sensitive. This means
66 that to be sure everything woks as it is supposed to
67 you should use the version of olsrd that the plugin 
68 was shipped with. If using CVS you should check 
69 out/update both olsrd and this plugin.
70
71 The plugin should now compile on windows and FreeBSD
72 as well.
73 To compile in windows:
74 make OS=win32
75 to compile in FreeBSD:
76 gmake OS=fbsd
77
78 installation:
79 make
80 make install
81
82 - Andreas T