6343fc252b38bf6ce587032f5044db725f9b6662
[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 grouped information:
20 * /all - all of the data in JSON format
21 * /runtime - all of the data that reflects the runtime status of olsrd and the mesh
22 * /startup - all of the data about the startup configuration
23
24 runtime information:
25 * /neighbors (including 2-hop)
26 * /links
27 * /routes
28 * /hna
29 * /mid
30 * /topology
31 * /gateways
32 * /interfaces
33 * /status - data that changes during runtime (all above commands combined)
34
35 start-up information:
36 * /config - the current configuration, i.e. what was loaded from the olsrd.conf
37 * /plugins - currently loaded plugins and their config parameters
38
39 start-up information not in JSON format:
40 * /olsrd.conf - the current config, formatted for writing directly to /etc/olsrd.conf
41
42
43    PLUGIN CONFIGURATION
44 ==========================
45
46 The plugin accepts two parameters: "port" and "accept". There are no
47 futher parameters.  Here's an example configuration for UNIX systems
48 (for Windows, change the plugin to end in .dll):
49
50 LoadPlugin "olsrd_jsoninfo.so.0.1"
51 {
52     # the default port is 9090 but you can change it like this:
53     #PlParam     "port"   "8080"
54
55     # You can set a "accept" single address to allow to connect to
56     # jsoninfo. If no address is specified, then localhost (127.0.0.1)
57     # is allowed by default.  jsoninfo will only use the first "accept"
58     # parameter specified and will ignore the rest.
59
60     # to allow a specific host:
61     #PlParam      "accept" "172.29.44.23"
62     # if you set it to 0.0.0.0, it will accept all connections
63     #PlParam      "accept" "0.0.0.0"
64 }