Added parameters for allowed hosts and networks
[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  ABOUT
5
6 This plugin implements a tiny HTTP server that
7 will gespond to a GET request by returning a HTML
8 formatted page contanin various information about
9 the currently running olsrd process.
10
11  PARAMETERS
12
13 The plugin takes the parameter "Port" "[portnumber]" 
14 to set the TCP port on which the server is to run. 
15 It defaults to 8080.
16 Now remember to open this port in your firewall if 
17 planning to access the HTTP server from a remote host!
18 The parameter "Host" "[IP address]" is used to allow
19 access from a single host(muliple such entries can
20 be set) and the parameter "Net" "[IP net] [IP mask]"
21 is used to allow access from entire net-ranges.
22 To allow access from all hosts do:
23  PlParam   "0.0.0.0" "0.0.0.0"
24
25 A configuration example:
26 LoadPlugin "olsrd_httpinfo.so.0.1"
27 {
28     PlParam     "port"   "80"
29     PlParam     "Host"   "163.24.87.3"
30     PlParam     "Host"   "80.23.53.22"
31     PlParam     "Net"    "10.0.0.0 255.0.0.0"
32     PlParam     "Net"    "192.168.0.0 255.255.0.0"
33 }
34
35 This will run the webserver on port 80(the normal
36 HTTP port) and allow access from the hosts 163.24.87.3
37 and 80.23.53.22 and the networks 10.0.0.0/8 and
38 192.168.0.0/16.
39 access is always allowed from 127.0.0.1(localhost).
40
41
42 NOTE!
43 If running olsrd 0.4.8, the plugin will not be able
44 to display the link set. Use CVs version of olsrd
45 if you need this functionallity.
46
47 The plugin should now compile on windows as well.
48 Do:
49 make OS=win32
50 Hey - this is my first port of anything to windows :-)
51
52 installation:
53 make
54 make install
55
56 - Andreas T