jsoninfo: update README
authorFerry Huberts <ferry.huberts@pelagic.nl>
Thu, 3 Dec 2015 10:18:11 +0000 (11:18 +0100)
committerFerry Huberts <ferry.huberts@pelagic.nl>
Thu, 3 Dec 2015 11:52:41 +0000 (12:52 +0100)
Signed-off-by: Ferry Huberts <ferry.huberts@pelagic.nl>
lib/jsoninfo/README_JSONINFO

index 8ae2e9f..af228e8 100644 (file)
@@ -1,39 +1,23 @@
+============
+INTRODUCTION
+============
 
-The jsoninfo plugin aims to deliver all of the information about the
-runtime status and configuration of olsrd.  You can request specific
-chunks of information, or overviews of runtime or startup
-configuration, or all of the information in one report. Additionally,
-the jsoninfo plugin will dump the current olsrd config in the
-olsrd.conf format.  The jsoninfo plugin provides all of the
-information that both the txtinfo and httpinfo plugins provide, as
-well as quite a bit more.
-
-There is a Java library called OlsrInfo that provides Java classes for
-parsing the data from jsoninfo (and txtinfo also).  It is based on the
-Jackson JSON processing library
-
-OlsrInfo: https://github.com/guardianproject/OlsrInfo
-Jackson JSON: http://jackson.codehaus.org/
+The jsoninfo plugin is an info plugin.
 
-PLUGIN USAGE
-============
+Please first read what's written in the file lib/info/README_INFO.
 
-There are a number of commands for getting information from this
-plugin.  They are designed to be tacked onto a URL, but can also be
-sent directly via a network socket. The commands are similar to the
-txtinfo plugin, but not exactly the same.
 
-If there is no command or no recognized command, then it sends the
-/status output, which is the combination of /neighbors, /links,
-/routes, /hna, /mid, /topology, /gateways, and /interfaces.
+==================
+SUPPORTED COMMANDS
+==================
 
-grouped information:
-* /all - all of the data in JSON format
-* /runtime - all of the data that reflects the runtime status of olsrd and the mesh
-* /startup - all of the data about the startup configuration
+Grouped information:
+* /all
+* /runtime
+* /startup
 
-runtime information:
-* /neighbors (including 2-hop)
+Runtime information:
+* /neighbors
 * /links
 * /routes
 * /hna
@@ -41,69 +25,38 @@ runtime information:
 * /topology
 * /gateways
 * /interfaces
-* /status - data that changes during runtime (all above commands combined)
+* /2hop
+* /sgw
+
+A special case for Freifunk, combining /neighbors and /links:
+* /neighbours
 
-start-up information:
-* /config - the current configuration, i.e. what was loaded from the olsrd.conf
-* /plugins - currently loaded plugins and their config parameters
+Start-up information:
+* /version
+* /config
+* /plugins
 
-start-up information not in JSON format:
-* /olsrd.conf - the current config, formatted for writing directly to /etc/olsrd/olsrd.conf
+The current configuration, formatted for writing directly to a configuration
+file, like /etc/olsrd/olsrd.conf:
+* /olsrd.conf
 
 
+====================
 PLUGIN CONFIGURATION
 ====================
 
-The plugin accepts two parameters: "port" and "accept". There are no
-futher parameters.  Here's an example configuration for UNIX systems
-(for Windows, change the plugin to end in .dll):
+The plugin is configured with the generic info plugin configuration parameters
+and with 1 extra parameter.
+
+The port in the generic info plugin configuration is set to 9090.
 
 LoadPlugin "olsrd_jsoninfo.so.0.0"
 {
-    # The port number on which the plugin will be listening
-    # PlParam     "port"               "9090"
-
-    # You can set an "accept" IP address that is allowed to connect to
-    # the plugin. If no address is specified, then localhost (127.0.0.1)
-    # is allowed by default.  Only the last parameter specified will be used,
-    # others will be ignored.
-    # Use 0.0.0.0 to accept all connections
-    # PlParam     "accept"             "127.0.0.1"
-
-    # You can set a "listen" IP address that is used to determine the interface
-    # on which the plugin will be listening. If no address is specified, then
-    # the plugin will listen on all interfaes. Only the last parameter specified
-    # will be used, others will be ignored.
-    # PlParam     "listen"             "0.0.0.0"
-
-    # Set to true to prepend HTTP headers before the JSON reply
-    # PlParam     "httpheaders"        "false"
+  # <generic info plugin configuration>
 
-    # Set to true to always allow connections from 127.0.0.1
-    # PlParam     "allowlocalhost"     "false"
-
-    # Set to true to only listen on IPv6 addresses when running in IPv6 mode.
-    # PlParam     "ipv6only"           "false"
-
-    # The first line of the specified file will be read. This line will then be
-    # included in the JSON reply as the value of the 'uuid' field.
-    # Mainly used for debugging.
-    # PlParam     "uuidfile"           "uuid.txt"
+  # The first line of the specified file will be read. If properly read, then
+  # this line will be included in the JSON reply as the value of the 'uuid'
+  # field.
+  # Default: <not set>
+  # PlParam "uuidfile" "uuid.txt"
 }
-
-
-Example Usage
-=============
-
-You can use http URLs with various web tools to access the information:
-
-  curl http://localhost:9090/all
-
-You can combine the various commands to generate a custom report:
-
-  curl http://localhost:9090/interfaces/routes/links
-
-If you want a copy of the current configuration, you can download it
-using this URL:
-
-  wget http://localhost:9090/olsrd.conf