[PATCH 2/2] doc: suricatta: document gservice configuration options

[Ken Sloat]

Update the General Suricatta Server section of the documentation to
include all discovered configuration variables in the example.

Additionally, add a detailed, well-formatted reStructuredText table
explaining the type and purpose of all 17 gservice configuration
parameters.

Signed-off-by: Ken Sloat <ksl...@cornersoftsolutions.com>
---
doc/source/suricatta.rst | 52 +++++++++++++++++++++++++++++++++++++++-
1 file changed, 51 insertions(+), 1 deletion(-)

diff --git a/doc/source/suricatta.rst b/doc/source/suricatta.rst
index a4081a63..29edf28a 100644
--- a/doc/source/suricatta.rst
+++ b/doc/source/suricatta.rst
@@ -425,7 +425,7 @@ The supported events are:
| fail | Failure by installing the new software |
+---------------+------------------------------------------------------------+

-The `general server` has an own section inside the configuration file. As example:
+The `general server` has its own section inside the configuration file. All channel-specific options (SSL, proxy, rate limiting, and custom headers) are supported. As an example:

::

@@ -433,6 +433,16 @@ The `general server` has an own section inside the configuration file. As exampl
{
url = ....;
logurl = ;
+ 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"},
@@ -441,6 +451,46 @@ The `general server` has an own section inside the configuration file. As exampl
);
}

+The available configuration options for the ``gservice`` section are:
+
++----------------------------+---------+-------------------------------------------------------------+
+| Parameter | Type | Description |
++============================+=========+=============================================================+
+| ``url`` | string | URL of the general suricatta server. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``logurl`` | string | URL where log/progress events are sent (via PUT). |
++----------------------------+---------+-------------------------------------------------------------+
+| ``polldelay`` | integer | Polling cycle in seconds. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``retry`` | integer | Number of retries to connect to the server. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``retrywait`` | integer | Time in seconds to wait between connection retries. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``nocheckcert`` | boolean | Skip SSL certificate validation if set to true. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``cafile`` | string | Path to the Certificate Authority (PEM) bundle file. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``sslkey`` | string | Path of the private key file for SSL connection. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``sslcert`` | string | Path of the certificate file for SSL connection. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``sslkeypassword`` | string | Password for the SSL private key. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``ciphers`` | string | Allowed ciphers suite list in CURL format. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``proxy`` | string | HTTP proxy address to reach the server. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``interface`` | string | Network interface or IP address to bind communication to. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``max-download-speed`` | string | Maximum download speed limit (e.g., "512k", "1M"). |
++----------------------------+---------+-------------------------------------------------------------+
+| ``api_key_header`` | string | HTTP custom header name used for API Key authentication. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``api_key`` | string | Custom API Key authentication value. |
++----------------------------+---------+-------------------------------------------------------------+
+| ``logevent`` | array | Array of tables for defining event reporting formats. |
++----------------------------+---------+-------------------------------------------------------------+
+

`date` is a special field and it is interpreted as localtime in RFC 2822 format. Each
Comma Separated field is looked up inside the `identify` section in the configuration
--
2.34.1