[PATCH 1/2] examples: swupdate.cfg: add gservice configuration example

[Ken Sloat]

Add an example configuration block for the suricatta "gservice"
(General Suricatta Server) backend.

Exhaustively document all 17 available parameters in the header
comments of the section, based on their definitions in the C
codebase (server_general.c and server_utils.c).

Signed-off-by: Ken Sloat <ksl...@cornersoftsolutions.com>
---
examples/configuration/swupdate.cfg | 62 +++++++++++++++++++++++++++++
1 file changed, 62 insertions(+)

diff --git a/examples/configuration/swupdate.cfg b/examples/configuration/swupdate.cfg
index f040155c..0bcf6ffc 100644
--- a/examples/configuration/swupdate.cfg
+++ b/examples/configuration/swupdate.cfg
@@ -301,6 +301,68 @@ suricatta :
*/
};

+#
+# gservice section: setup for general suricatta server backend
+#
+# url : string
+# URL of the general suricatta server
+# logurl : string
+# URL where log / progress events are sent (via PUT)
+# polldelay : integer
+# polling cycle (seconds)
+# retry : integer
+# number of retries to connect to server
+# retrywait : integer
+# time to wait in seconds between connection retries
+# nocheckcert : bool
+# if set to true, skip SSL certificate validation
+# cafile : string
+# file with Public Certificate Authority
+# sslkey : string
+# path of the file containing the private key for SSL connection
+# sslcert : string
+# path of the file containing the certificate for SSL connection
+# sslkeypassword : string
+# password for the SSL private key
+# ciphers : string
+# cipher suite list in the format used by CURL
+# proxy : string
+# HTTP proxy address
+# interface : string
+# interface name (e.g. "eth0") or IP address to bind communication channel to.
+# max-download-speed : string
+# Specify maximum download speed to use (e.g., "512k")
+# api_key_header : string
+# HTTP header name for custom API key authentication
+# api_key : string
+# API key value for the custom header
+# logevent : array of tables
+# defined events and their formatting for log reports
+# Each entry requires 'event' (e.g. "check", "started", "success", "fail")
+# and 'format' (comma-separated list of keys from 'identify' section or 'date' or constants)
+#
+gservice :
+{
+ url = "http://gserver.example.com/update";
+ logurl = "http://gserver.example.com/log";
+ polldelay = 30;
+ nocheckcert = false;
+ retry = 3;
+ retrywait = 10;
+ max-download-speed = "512k";
+/*
+ cafile = "/etc/ssl/cafile";
+ sslkey = "/etc/ssl/sslkey";
+ sslcert = "/etc/ssl/sslcert";
+*/
+ logevent : (
+ {event = "check"; format="#2,date,fw,hw,sp"},
+ {event = "started"; format="#12,date,fw,hw,sp"},
+ {event = "success"; format="#13,date,fw,hw,sp"},
+ {event = "fail"; format="#14,date,fw,hw,sp"}
+ );
+};
+
#
# webserver : setup for the embedded webserver
# see ./swupdate -h for details
--
2.34.1