jsoninfo: document the existing command set
[olsrd.git] / lib / jsoninfo / README_JSONINFO
1
2    PLUGIN USAGE
3 ==================
4
5 installation:
6 make
7 make install
8
9
10 There are a number of commands for getting information from this
11 plugin.  They are designed to be tacked onto a URL, but can also be
12 sent directly via a network socket. The commands are similar to the
13 txtinfo plugin, but not exactly the same.
14
15 If there is no command or no recognized command, then it sends the
16 /status output, which is the combination of /neighbors, /links,
17 /routes, /hna, /mid, /topology, /gateways, and /interfaces.
18
19 runtime information:
20 * /neighbors (including 2-hop)
21 * /links
22 * /routes
23 * /hna
24 * /mid
25 * /topology
26 * /gateways
27 * /interfaces
28 * /status - data that changes during runtime (all above commands combined)
29
30 static information:
31 * /config - the current configuration, i.e. what was loaded from the olsrd.conf
32 * /plugins - currently loaded plugins and their config parameters
33 * /olsrd.conf - the current config, formatted for writing directly to /etc/olsrd.conf
34
35
36    PLUGIN CONFIGURATION
37 ==========================
38
39 The plugin accepts two parameters: "port" and "accept". There are no
40 futher parameters.  Here's an example configuration for UNIX systems
41 (for Windows, change the plugin to end in .dll):
42
43 LoadPlugin "olsrd_jsoninfo.so.0.1"
44 {
45     # the default port is 9090 but you can change it like this:
46     #PlParam     "port"   "8080"
47
48     # You can set a "accept" single address to allow to connect to
49     # jsoninfo. If no address is specified, then localhost (127.0.0.1)
50     # is allowed by default.  jsoninfo will only use the first "accept"
51     # parameter specified and will ignore the rest.
52
53     # to allow a specific host:
54     #PlParam      "accept" "172.29.44.23"
55     # if you set it to 0.0.0.0, it will accept all connections
56     #PlParam      "accept" "0.0.0.0"
57 }