doc: a few fixes/improvements ad STOMP bots and *n6* feed

CHANGELOG.md

@@ -35,8 +35,8 @@ CHANGELOG
 ### Bots
 #### Collectors
 - `intelmq.bots.collectors.stomp.collector` (PR#2408 by Jan Kaliszewski):
-  - Add support for authentication based on STOMP login and passcode,
-    introducing 3 new configuration parameters (see above: *Configuration*).
+  - Add support for authentication based on STOMP login and passcode, introducing three
+    new configuration parameters (see above: *Configuration*).
   - Update the code to support new versions of `stomp.py`, including the latest (`8.1.0`);
     fixes [#2342](https://github.com/certtools/intelmq/issues/2342).
   - Fix the reconnection behavior: do not attempt to reconnect after `shutdown`. Also,
@@ -55,8 +55,8 @@ CHANGELOG
 
 #### Outputs
 - `intelmq.bots.outputs.stomp.output` (PR#2408 by Jan Kaliszewski):
-  - Add support for authentication based on STOMP login and passcode,
-    introducing 3 new configuration parameters (see above: *Configuration*).
+  - Add support for authentication based on STOMP login and passcode, introducing three
+    new configuration parameters (see above: *Configuration*).
   - Update the code to support new versions of `stomp.py`, including the latest (`8.1.0`).
   - Fix `AttributeError` caused by attempts to get unset attributes of `StompOutputBot`
     (`ssl_ca_cert` et consortes).

docs/user/bots.rst

@@ -945,11 +945,12 @@ Install the `stomp.py` library from PyPI:
 **Configuration Parameters**
 
 * **Feed parameters** (see above)
-* `exchange`: STOMP *destination* to subscribe to, e.g. "/exchange/my.org/*.*.*.*"
-* `port`: 61614
-* `server`: hostname, e.g. "n6stream.cert.pl"
+* `server`: STOMP server's hostname or IP, e.g. "n6stream.cert.pl" (which is default)
+* `port`: STOMP server's port number (default: 61614)
+* `exchange`: STOMP *destination* to subscribe to, e.g. "/exchange/my.example.org/*.*.*.*"
+* `heartbeat`: default: 6000
 * `ssl_ca_certificate`: path to CA file
-* `auth_by_ssl_client_certificate`: Boolean, default: true (note: set to false for new *n6* auth)
+* `auth_by_ssl_client_certificate`: Boolean, default: true (note: false is needed for new *n6* auth)
 * `ssl_client_certificate`: path to client cert file, used only if `auth_by_ssl_client_certificate` is true
 * `ssl_client_certificate_key`: path to client cert key file, used only if `auth_by_ssl_client_certificate` is true
 * `username`: STOMP *login* (e.g., *n6* user login), used only if `auth_by_ssl_client_certificate` is false
@@ -4308,16 +4309,16 @@ Also you will need a so called "exchange point".
 
 **Configuration Parameters**
 
-* `exchange`: STOMP *destination* to push at, e.g. "/exchange/_push"
+* `exchange`: STOMP *destination* to push at, e.g. "/exchange/_push" (which is default)
 * `heartbeat`: default: 60000
 * `message_hierarchical_output`: Boolean, default: false
 * `message_jsondict_as_string`: Boolean, default: false
 * `message_with_type`: Boolean, default: false
-* `port`: Integer, default: 61614
-* `server`: Host or IP address of the STOMP server
+* `server`: STOMP server's hostname or IP, e.g. "n6stream.cert.pl" or "127.0.0.1" (which is default)
+* `port`: STOMP server's port number (default: 61614)
 * `single_key`: Boolean or string (field name), default: false
 * `ssl_ca_certificate`: path to CA file
-* `auth_by_ssl_client_certificate`: Boolean, default: true (note: set to false for new *n6* auth)
+* `auth_by_ssl_client_certificate`: Boolean, default: true (note: false is needed for new *n6* auth)
 * `ssl_client_certificate`: path to client cert file, used only if `auth_by_ssl_client_certificate` is true
 * `ssl_client_certificate_key`: path to client cert key file, used only if `auth_by_ssl_client_certificate` is true
 * `username`: STOMP *login* (e.g., *n6* user login), used only if `auth_by_ssl_client_certificate` is false

intelmq/etc/feeds.yaml

@@ -1149,20 +1149,20 @@ providers:
       public: false
   CERT.PL:
     N6 Stomp Stream:
-      description: N6 Collector - CERT.pl's N6 Collector - N6 feed via STOMP interface.
-        Note that rate_limit does not apply for this bot as it is waiting for messages
+      description: N6 Collector - CERT.pl's *n6* Stream API feed (via STOMP interface).
+        Note that 'rate_limit' does not apply to this bot, as it is waiting for messages
         on a stream.
-      additional_information: Contact cert.pl to get access to the feed.
+      additional_information: Contact CERT.pl to get access to the feed.
       bots:
         collector:
           module: intelmq.bots.collectors.stomp.collector
           parameters:
-            exchange: "{insert your exchange point as given by CERT.pl}"
+            exchange: "{insert your STOMP *destination* to subscribe to, as given by CERT.pl, e.g. /exchange/my.example.org/*.*.*.*}"
             ssl_ca_certificate: "{insert path to CA file for CERT.pl's n6}"
             auth_by_ssl_client_certificate: false
-            username: "{insert n6 user's login}"
-            password: "{insert n6 user's API key}"
-            port: '61614'
+            username: "{insert your *n6* login, e.g. [email protected]}"
+            password: "{insert your *n6* API key}"
+            port: 61614
             server: n6stream.cert.pl
             name: __FEED__
             provider: __PROVIDER__