commit fa4a7b2502085832bd3dd527d019ed40fbc4f1c8
parent b3686a3198dbd5530773d52ebbb0f3f72eb8ac22
Author: Antoine A <>
Date: Tue, 30 Dec 2025 13:32:58 +0100
taler-rust: update configuration and manuals
Diffstat:
5 files changed, 46 insertions(+), 2 deletions(-)
diff --git a/core/api-ebisync.rst b/core/api-ebisync.rst
@@ -38,7 +38,7 @@ Config
.. http:get:: /config
Return the protocol version and configuration information about the bank.
- This specification corresponds to ``current`` protocol being version **v11**.
+ This specification corresponds to ``current`` protocol being version **v0**.
**Response:**
diff --git a/manpages/taler-cyclos.conf.5.rst b/manpages/taler-cyclos.conf.5.rst
@@ -43,6 +43,9 @@ WORKER OPTIONS
The following options are from the “[cyclos-worker]” section.
+FREQUENCY
+ How often should worker run when no notification is received
+
API_URL
Base URL of the Cyclos API server.
diff --git a/manpages/taler-magnet-bank.conf.5.rst b/manpages/taler-magnet-bank.conf.5.rst
@@ -40,6 +40,9 @@ WORKER OPTIONS
The following options are from the “[magnet-bank-worker]” section.
+FREQUENCY
+ How often should worker run
+
API_URL
Base URL of the Magnet Bank API server.
diff --git a/taler-cyclos-manual.rst b/taler-cyclos-manual.rst
@@ -185,10 +185,15 @@ Update the configuration files:
CURRENCY = KUDOS
.. code-block:: ini
- :caption: /etc/taler-cyclos/secrets/cyclos-worker.secret.conf
+ :caption: /etc/taler-cyclos/conf.d/cyclos-worker.conf
[cyclos-worker]
API_URL = https://demo.cyclos.org/api/
+
+.. code-block:: ini
+ :caption: /etc/taler-cyclos/secrets/cyclos-worker.secret.conf
+
+ [cyclos-worker]
USERNAME = admin
PASSWORD = password
@@ -248,6 +253,23 @@ Check the server is correctly configured:
$ sudo -u taler-cyclos-httpd taler-cyclos -c /etc/taler-cyclos/taler-cyclos.conf serve --check
+Configuration
+=============
+
+Here are some configuration you might want to change:
+
+Worker frequency
+----------------
+
+The worker runs periodically to index the history and initiate payments. It also listens to real-time notifications to index new transfers as soon as they are announced.
+If the network does not allow notifications to be received, it is best for the worker to run more often; otherwise, you can reduce the frequency. Keep in mind that a very high frequency can place a significant load on your network provider.
+
+.. code-block:: ini
+ :caption: /etc/taler-cyclos/conf.d/cyclos-worker.conf
+
+ [cyclos-worker]
+ FREQUENCY = 3m
+
Deployment
==========
diff --git a/taler-magnet-bank-manual.rst b/taler-magnet-bank-manual.rst
@@ -219,6 +219,22 @@ Check the server is correctly configured:
$ sudo -u taler-magnet-bank-httpd taler-magnet-bank -c /etc/taler-magnet-bank/taler-magnet-bank.conf serve --check
+Configuration
+=============
+
+Here are some configuration you might want to change:
+
+Worker frequency
+----------------
+
+The worker runs periodically to index the bank history and initiate payments. It is best to run the worker often to make withdrawal faster but keep in mind that a very high frequency can place a significant load on your network provider.
+
+.. code-block:: ini
+ :caption: /etc/taler-magnet-bank/conf.d/magnet-bank-worker.conf
+
+ [magnet-bank-worker]
+ FREQUENCY = 3m
+
Deployment
==========
