Merge branch 'release-0.6.8'
[olsrd.git] / lib / httpinfo / README_HTTPINFO
1 HTTP MINI-SERVER PLUGIN FOR OLSRD 0.1
2 by Andreas Tonnesen(andreto@olsr.org)
3
4 -----------------------------------------------------
5
6  ABOUT
7
8 This plugin implements a tiny HTTP server that will respond to a GET request
9 by returning a HTML formatted page containing information about the currently
10 running olsrd process.
11
12 This information includes detailed link status for all links and neighbors, all
13 olsrd routes in the kernel, local configuration, uptime and more. The plugin
14 can also generate an olsrd configfile based on current running configuration.
15
16 In adittion an experimental administrtion interface is available.
17
18 -----------------------------------------------------
19
20 Remember to open the port in your firewall if planning to access the HTTP
21 server from a remote host!
22
23 LoadPlugin "olsrd_httpinfo.so.0.1"
24 {
25     # The port number on which the plugin will be listening
26     # PlParam     "port"               "1978"
27
28     # IP addresses that can access the plugin, use "0.0.0.0" to allow everyone
29     # Access is always allowed from localhost (127.0.0.1).
30     # PlParam     "host"               "127.0.0.1"
31     # PlParam     "host"               "80.23.53.22"
32
33     # Networks that can access the plugin (ip/netmask), use 0.0.0.0/0 to allow
34     # everyone.
35     # Access is always allowed from localhost (127.0.0.1).
36     # PlParam     "net"                "0.0.0.0/0"
37     # PlParam     "net"                "104.0.0.0/16"
38     # PlParam     "net"                "192.168.0.0/16"
39
40     # Set to true to resolve host names
41     # PlParam     "resolve"            "false"
42 }
43
44 -----------------------------------------------------
45
46  EXPERIMENTAL ADMIN INTERFACE
47
48 The plugin can be compiled with a experimental administrator interface. This
49 is a web page that will let the user change olsrd settings in real-time.
50
51 To compile with this feature pass ADMIN_INTERFACE=1 as an argument to make
52 (eg. make ADMIN_INTERFACE=1)
53
54 -----------------------------------------------------
55
56 NOTE!
57 This plugin is very olsrd version sensitive. This means that to be sure
58 everything works as it is supposed to you should use the version of olsrd that
59 the plugin was shipped with. If using CVS you should check out/update both
60 olsrd and this plugin.
61
62 The plugin should now compile on windows and FreeBSD as well.
63
64 To compile in windows:
65   make OS=win32
66 To compile in FreeBSD:
67   gmake OS=fbsd
68
69 Installation:
70 make
71 make install
72
73 - Andreas T