commit 2998c5664532695d0591b25bf5b674ad22571458
parent be6ccffcd164481090f4ac151b0c316ca92e1b1a
Author: Christian Grothoff <christian@grothoff.org>
Date: Sun, 4 Aug 2024 21:00:35 +0200
add example
Diffstat:
1 file changed, 18 insertions(+), 8 deletions(-)
diff --git a/manpages/taler-mdb-network-check.sh.1.rst b/manpages/taler-mdb-network-check.sh.1.rst
@@ -37,33 +37,43 @@ Its options are as follows:
Print short help on options.
-When the network goes down, it will kill *PROGRAM*, then call *FAIL_HELPER* with one of the following error codes (followed by relaunching *PROGRAM* and killing *FAIL_HELPER* once the network is up again) - note that we check in the order these are listed:
+When the network goes down, it will kill *PROGRAM*, then call *FAIL_HELPER* with one of the following error codes (followed by killing *FAIL_HELPER* and relaunching *PROGRAM* once the network is up again) - note that we check in the order these are listed:
**no-ip**
- Network Down: Could not reach the DNS Server. (DNS Server is first **nameserver** entry in **/etc/resolv.conf**)
+ Network Down: Could not reach the DNS Server. (DNS Server is first **nameserver** entry in **/etc/resolv.conf**.)
**backend-dns-resolution-failure**
- Name Resolution Failed: Could not resolve the Taler backend hostname. Check DNS. (**dig** picks it's own nameservers; we don't force it to use the one we pinged)
+ Name Resolution Failed: Could not resolve the Taler backend hostname. Check DNS. (**dig** picks its own nameservers; we do not force it to use the one we pinged.)
**backend-unreachable**
Backend Unreachable: Could not reach payment backend.
**backend-no-webserver**
- Backend No Webserver: We cannot find a webserver on a backend. Ensure requests are properly routing to it. (X509 certificate is not checked against here)
+ Backend No Webserver: We cannot find a webserver on a backend. Ensure requests are properly routing to it. (X509 certificate is not verified here.)
**backend-x509-cert-bad**
- Bad Certificate: The Taler backend gave us a bad certificate. Check X509.
+ Bad Certificate: The Taler backend gave us a bad TLS certificate. Check the X509 setup.
**backend-auth-failure**
- Backend Auth Failure: Taler credentials are invalid. Check machine configuration.
+ Backend Authentication Failure: The credentials are invalid. Check your configuration.
-The aforementioned *FAIL_HELPER* also gets called if the network isn't up in the first place.
+The aforementioned *FAIL_HELPER* also gets called if the network is not up in the first place.
-In short, *FAIL_HELPER* will be running whenever then etwork is down, and *PROGRAM* will be running whenever it's up.
+In short, *FAIL_HELPER* will be running whenever the network is down, and *PROGRAM* will be running whenever its up.
The network is checked every **30 seconds**.
+Example
+=======
+
+A canonical use of the script to launch taler-mdb would be:
+
+.. code-block:: console
+
+ # /usr/bin/taler-mdb-network-check.sh -c /etc/taler-mdb.conf -- \
+ /usr/bin/taler-mdb -c /etc/taler-mdb.conf
+
See Also
========
