summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAntoine A <>2024-03-01 10:30:17 +0100
committerAntoine A <>2024-03-01 10:30:17 +0100
commit85d1f0a0def91ee0fafccdde7fdf9c514b1a486b (patch)
treee25a50c958ca108a4f24ae92834da9c10582d433
parent6611af24895160a72aa2fdd69f54cd2cbff8f2bb (diff)
downloaddocs-85d1f0a0def91ee0fafccdde7fdf9c514b1a486b.tar.gz
docs-85d1f0a0def91ee0fafccdde7fdf9c514b1a486b.tar.bz2
docs-85d1f0a0def91ee0fafccdde7fdf9c514b1a486b.zip
Improve regional currency manual
-rw-r--r--libeufin/regional-automated-manual.rst34
-rw-r--r--libeufin/regional-custom-manual.rst31
2 files changed, 64 insertions, 1 deletions
diff --git a/libeufin/regional-automated-manual.rst b/libeufin/regional-automated-manual.rst
index 937831f9..4fe492ab 100644
--- a/libeufin/regional-automated-manual.rst
+++ b/libeufin/regional-automated-manual.rst
@@ -105,6 +105,8 @@ The script will start by installing the required packages and then asking you fu
#. Whether to use TLS or not. You should answer ``y`` in most cases.
#. Whether to setup SMS two-factor authentication using `Telesign <https://www.telesign.com>`_, multi-factor authentication is strongly recommended, especially when regional currency can be converted to fiat currency. This requires `a Customer ID and an API Key <https://developer.telesign.com/enterprise/docs/authentication#basic-authentication>`_. You should answer ``y`` in most cases.
#. The admin password for the bank. Be absolutely sure to enter a very, very long and high-entropy password, preferably using the autogenerated one.
+#. Whether to generate terms of service (ToS) for the exchange from default templates.
+#. Whether to generate a privacy policy for the exchange from default templates.
The information you entered as well as the generated bank admin password will
be stored in a file called ``config/user.conf``. If you run the script in
@@ -241,7 +243,7 @@ By default, the exchange is setup to perform conversion without any restrictions
upload
.. note::
- Refer to the manpage ``taler-exchange-offline`` for a full array or possible restrictions.
+ Refer to the manpage ``taler-exchange-offline`` for a full array of possible restrictions.
System ON!
++++++++++
@@ -254,4 +256,34 @@ outgoing bank transactions <sending-payments>` (cash out).
# systemctl enable --now libeufin-nexus.target
+Configuring exchange terms
+++++++++++++++++++++++++++
+
+You can use your own terms of service and privacy policy. You can use the default templates in ``/usr/share/taler/terms`` as a guide.
+Assuming you have custom terms of service and privacy policy ``rst`` teamplte files at ``TOS_PATH`` and ``PRIVACY_PATH``, the following commands generate the terms files:
+
+.. code-block:: console
+
+ # taler-terms-generator -i "$TOS_PATH"
+ # taler-terms-generator -i "$PRIVACY_PATH"
+
+You now have to specify the terms file names in the exchange config:
+
+.. code-block:: console
+
+ # TERMS_ETAG="$(basename "$TOS_PATH" .rst)"
+ # PRIVACY_ETAG="$(basename "$PRIVACY_PATH" .rst)"
+
+.. code-block:: ini
+
+ [exchange]
+ TERMS_ETAG=${TERMS_ETAG}
+ PRIVACY_ETAG=${PRIVACY_ETAG}
+
+Make sure to restart taler-exchange after changing these configuration options:
+
+.. code-block:: console
+
+ # systemctl restart taler-exchange.target
+
.. include:: ../frags/regional-manual-use.rst
diff --git a/libeufin/regional-custom-manual.rst b/libeufin/regional-custom-manual.rst
index 842b943b..a6060586 100644
--- a/libeufin/regional-custom-manual.rst
+++ b/libeufin/regional-custom-manual.rst
@@ -118,4 +118,35 @@ outgoing bank transactions <sending-payments>` (cash out).
# systemctl enable --now libeufin-nexus.target
+
+Configuring exchange terms
+++++++++++++++++++++++++++
+
+You can use your own terms of service and privacy policy. You can use the default templates in ``/usr/share/taler/terms`` as a guide.
+Assuming you have custom terms of service and privacy policy ``rst`` teamplte files at ``TOS_PATH`` and ``PRIVACY_PATH``, the following commands generate the terms files:
+
+.. code-block:: console
+
+ # taler-terms-generator -i "$TOS_PATH"
+ # taler-terms-generator -i "$PRIVACY_PATH"
+
+You now have to specify the terms file names in the exchange config:
+
+.. code-block:: console
+
+ # TERMS_ETAG="$(basename "$TOS_PATH" .rst)"
+ # PRIVACY_ETAG="$(basename "$PRIVACY_PATH" .rst)"
+
+.. code-block:: ini
+
+ [exchange]
+ TERMS_ETAG=${TERMS_ETAG}
+ PRIVACY_ETAG=${PRIVACY_ETAG}
+
+Make sure to restart taler-exchange after changing these configuration options:
+
+.. code-block:: console
+
+ # systemctl restart taler-exchange.target
+
.. include:: ../frags/regional-manual-use.rst \ No newline at end of file