summaryrefslogtreecommitdiff
path: root/frags
diff options
context:
space:
mode:
Diffstat (limited to 'frags')
-rw-r--r--frags/common-conf-syntax.rst16
-rw-r--r--frags/configuration-format.rst13
-rw-r--r--frags/installing-ubuntu.rst10
-rw-r--r--frags/legal.rst32
-rw-r--r--frags/regional-manual-use.rst99
-rw-r--r--frags/regional-system-on.rst18
6 files changed, 54 insertions, 134 deletions
diff --git a/frags/common-conf-syntax.rst b/frags/common-conf-syntax.rst
index 27c8ba87..2ca15058 100644
--- a/frags/common-conf-syntax.rst
+++ b/frags/common-conf-syntax.rst
@@ -46,14 +46,14 @@ from `GNU autoconf
values are usually dependent on an ``INSTALL_PREFIX`` which is determined by
the ``--prefix`` option given to configure. The canonical values are:
- * LIBEXECDIR = $INSTALL_PREFIX/taler/libexec/
- * DOCDIR = $INSTALL_PREFIX/share/doc/taler/
- * ICONDIR = $INSTALL_PREFIX/share/icons/
- * LOCALEDIR = $INSTALL_PREFIX/share/locale/
- * PREFIX = $INSTALL_PREFIX/
- * BINDIR = $INSTALL_PREFIX/bin/
- * LIBDIR = $INSTALL_PREFIX/lib/taler/
- * DATADIR = $INSTALL_PREFIX/share/taler/
+* LIBEXECDIR = $INSTALL_PREFIX/taler/libexec/
+* DOCDIR = $INSTALL_PREFIX/share/doc/taler/
+* ICONDIR = $INSTALL_PREFIX/share/icons/
+* LOCALEDIR = $INSTALL_PREFIX/share/locale/
+* PREFIX = $INSTALL_PREFIX/
+* BINDIR = $INSTALL_PREFIX/bin/
+* LIBDIR = $INSTALL_PREFIX/lib/taler/
+* DATADIR = $INSTALL_PREFIX/share/taler/
Note that on some platforms, the given paths may differ depending
on how the system was compiled or installed, the above are just the
diff --git a/frags/configuration-format.rst b/frags/configuration-format.rst
index 489e98cb..5a74c775 100644
--- a/frags/configuration-format.rst
+++ b/frags/configuration-format.rst
@@ -11,7 +11,7 @@ In order to override these defaults, the user can write a custom configuration
file and either pass it to the component at execution time using the *-c*
option, or name it taler.conf and place it under $HOME/.config/ which is where
components will look by default. Note that the systemd service files pass ``-c
-/etc/taler/taler.conf``, thus making ``/etc/taler/taler.conf``
+/etc/taler/taler.conf``, thus making ``/etc/taler/taler.conf``
the primary location for the configuration.
A config file is a text file containing sections, and each section
@@ -35,9 +35,9 @@ variables that are unset, by using the following syntax:
``${VAR:-default}``. There are two ways a user can set the value
of ``$``-prefixable variables:
- (1) by defining them under a ``[paths]`` section:
+(1) by defining them under a ``[paths]`` section:
- .. code-block:: ini
+ .. code-block:: ini
[paths]
TALER_DEPLOYMENT_SHARED = ${HOME}/shared-data
@@ -45,11 +45,11 @@ of ``$``-prefixable variables:
[section-x]
path-x = ${TALER_DEPLOYMENT_SHARED}/x
- (2) or by setting them in the environment:
+(2) or by setting them in the environment:
- .. code-block:: console
+ .. code-block:: console
- $ export VAR=/x
+ $ export VAR=/x
The configuration loader will give precedence to variables set under
``[path]`` over environment variables.
@@ -62,4 +62,3 @@ pathnames, when they use several levels of ``$``-expanded variables. See
The repository ``git://git.taler.net/deployment`` contains example code
for generating configuration files under ``deployment/netzbon/``.
-
diff --git a/frags/installing-ubuntu.rst b/frags/installing-ubuntu.rst
index c1868998..89ca4dc9 100644
--- a/frags/installing-ubuntu.rst
+++ b/frags/installing-ubuntu.rst
@@ -11,13 +11,17 @@ would look like this for Ubuntu Lunar:
deb [signed-by=/etc/apt/keyrings/taler-systems.gpg] https://deb.taler.net/apt/ubuntu/ lunar taler-lunar
-For Ubuntu Jammy use this instead:
+For Ubuntu Mantic use this instead:
.. code-block::
- deb [signed-by=/etc/apt/keyrings/taler-systems.gpg] https://deb.taler.net/apt/ubuntu/ jammy taler-jammy
+ deb [signed-by=/etc/apt/keyrings/taler-systems.gpg] https://deb.taler.net/apt/ubuntu/ mantic taler-mantic
-The last line is crucial, as it adds the GNU Taler packages.
+For Ubuntu Noble use this instead:
+
+.. code-block::
+
+ deb [signed-by=/etc/apt/keyrings/taler-systems.gpg] https://deb.taler.net/apt/ubuntu/ noble taler-noble
Next, you must import the Taler Systems SA public package signing key
into your keyring and update the package lists:
diff --git a/frags/legal.rst b/frags/legal.rst
index dcecfaa0..be9b7f91 100644
--- a/frags/legal.rst
+++ b/frags/legal.rst
@@ -35,14 +35,14 @@ no terms of service available.
To configure the terms of service response, there are two options
in the configuration file for the service:
-- ``TERMS_ETAG``: The current "Etag" to return for the terms of service.
- This value must be changed whenever the terms of service are
- updated. A common value to use would be a version number.
- Note that if you change the ``TERMS_ETAG``, you MUST also provide
- the respective files in ``TERMS_DIR`` (see below).
-- ``TERMS_DIR``: The directory that contains the terms of service.
- The files in the directory must be readable to the service
- process.
+- ``TERMS_ETAG``: The current "Etag" to return for the terms of service.
+ This value must be changed whenever the terms of service are
+ updated. A common value to use would be a version number.
+ Note that if you change the ``TERMS_ETAG``, you MUST also provide
+ the respective files in ``TERMS_DIR`` (see below).
+- ``TERMS_DIR``: The directory that contains the terms of service.
+ The files in the directory must be readable to the service
+ process.
Privacy Policy
@@ -58,14 +58,14 @@ is no privacy policy available.
To configure the privacy policy response, there are two options
in the configuration file for the service:
-- ``PRIVACY_ETAG``: The current "Etag" to return for the privacy policy.
- This value must be changed whenever the privacy policy is
- updated. A common value to use would be a version number.
- Note that if you change the ``PRIVACY_ETAG``, you MUST also provide
- the respective files in ``PRIVACY_DIR`` (see below).
-- ``PRIVACY_DIR``: The directory that contains the privacy policy.
- The files in the directory must be readable to the service
- process.
+- ``PRIVACY_ETAG``: The current "Etag" to return for the privacy policy.
+ This value must be changed whenever the privacy policy is
+ updated. A common value to use would be a version number.
+ Note that if you change the ``PRIVACY_ETAG``, you MUST also provide
+ the respective files in ``PRIVACY_DIR`` (see below).
+- ``PRIVACY_DIR``: The directory that contains the privacy policy.
+ The files in the directory must be readable to the service
+ process.
Legal policies directory layout
diff --git a/frags/regional-manual-use.rst b/frags/regional-manual-use.rst
deleted file mode 100644
index f33d9010..00000000
--- a/frags/regional-manual-use.rst
+++ /dev/null
@@ -1,99 +0,0 @@
-Using the Regional Currency
-===========================
-
-The very first step you should check afte the installation process has been
-completed successfully, is to make sure all three URLs (bank,backend and exchange),
-are available (this means to see a Website, and not any NGINX error).
-
-
-Bank backend walkthrough
-+++++++++++++++++++++++++
-
-- As stated above, please visit before "https://bank.yourdomain.ltd", to make sure it is available.
-
-- Now login with the username "admin" and the password you have choosen during the installation process, or use the one which might
- have been generated automatically (and shown on your terminal screen), during the installation process.
- Once inside the Bank Administrator area, please create the "very first" customer account.
-
-- Transfer some funds from the "admin" bank account to this new customer account.
-
-- Now logout from the "admin" account, and login again using the recently "customer" account you have created, and make sure the funds you have transfered from admin, have arrived correctly.
-
-- Now, please choose the option "Send Money to a Taler Wallet", and try to send for example 100 units of your regional currency to the
- wallet installed on your browser or mobile phone.
-
-- Now try to spend some of these funds from your wallet, and try to buy something somewhere, with the same digital currency you have choosen, during your installation process, let's say Netzbon.
-
-- Lastly, you can also try to transfer funds to another "bank account",for that you will need to know the recipient's username or the bank account ID.
-
-If you have successfully accomplished all the previous steps, for the bank administrator
-backend and your installed Wallet, you can move now to test other components such
-as the Merchant backend (https://backend.yourdomain.ltd).
-
-Wallet Setup
-++++++++++++
-
-This section describes the interaction between the Taler graphical wallet (Android,
-iOS, WebExtensions) and the regional currency system.
-
-You need to add your regional currency exchange to the wallet. This can
-be done by scanning a QR code with a ``taler://withdraw-exchange/exchange.$DOMAIN/$MASTER_PUB``
-URL or by manually entering the URL into the respective ``Add exchange``
-dialogue.
-
-
-Cash-In
-+++++++
-
-Next, start the withdraw process in the Taler wallet for the respective
-currency and specify the desired amount. The wallet will then show you the
-details of the fiat wire transfer that must be made for the cash-in to be
-completed. Once the money has arrived at the fiat bank account, Nexus will
-obtain the transaction data and the regional currency bank will create the
-corresponding amount in regional currency, crediting the GNU Taler exchange
-account. In turn, the exchange will issue the respective amount to your
-wallet.
-
-.. note::
-
- Cash-in operations may be subject to conversion rates, conversion fees and
- minimum amounts to be transferred.
-
-
-Making payments
-+++++++++++++++
-
-For testing, you should be able to *deposit* regional currency directly into
-your regional currency libeufin-bank account directly from the Taler wallet.
-For this, you primarily need to know your bank account details (which should
-be accessible by clicking on your name in the bank Web site after logging in).
-
-.. note::
-
- There may be a short delay between the wallet making the deposit and
- the exchange crediting your bank account. This is because the wallet
- uses a small wire transfer delay by default when initiating a deposit
- into a bank account.
-
-For production, it is more common for a shop to configure a :ref:`Taler
-merchant backend <taler-merchant-backend-operator-manual>` or at least use an
-instance within such a setup. To configure an instance, you primarily need
-again the bank account details to :ref:`setup instance bank accounts
-<instance-bank-account>`.
-
-
-Cash-Out
-++++++++
-
-Regional currency accounts that have a positive balance could be eligible for
-cash-out. Cash-out operations may again be restricted by the regional
-currency operator and will *only* be made to the respective pre-configured
-fiat currency bank account. To cash-out, simply log into your regional
-currency account, select cash-out, specify the desired amount and pass the
-second-factor authorization challenge by entering the TAN you receive at the
-registered e-mail address or mobile phone number.
-
-.. note::
-
- Cash-out operations may be subject to conversion rates, conversion fees and
- minimum amounts to be transferred.
diff --git a/frags/regional-system-on.rst b/frags/regional-system-on.rst
index 7a150cbf..1a2898e0 100644
--- a/frags/regional-system-on.rst
+++ b/frags/regional-system-on.rst
@@ -21,8 +21,24 @@ The last step is to enable libeufin-nexus to :ref:`import incoming bank
transactions <receive-transaction-data>` (cash in) and to :ref:`trigger
outgoing bank transactions <sending-payments>` (cash out).
+First, check that libeufin-nexus is correctly configured by running the following commands:
+
+.. code-block:: console
+
+ # sudo -u libeufin-nexus libeufin-nexus ebics-setup
+ # sudo -u libeufin-nexus libeufin-nexus ebics-fetch --transient
+ # sudo -u libeufin-nexus libeufin-nexus ebics-submit --transient
+
+If you have old transactions after the date YYYY-MM-DD that you wish to import into the database, run the following command:
+
+.. code-block:: console
+
+ # sudo -u libeufin-nexus libeufin-nexus ebics-fetch --transientt --pinned-start YYYY-MM-DD
+
+None of those commands should fail. If they all work, you can enable the services:
+
.. code-block:: console
# systemctl enable --now libeufin-nexus.target
-.. FIXME: explain how to test if libeufin is working!
+Now that we know that libeufin-nexus is working correctly, we still need to check that communication with your bank is working properly. We will test this later, at :ref:`the end of the manual <regional-use>`. The system should only be considered functional after a successful :ref:`cash in <regional-use-cashin>` and :ref:`cash out <regional-use-cashout>`. \ No newline at end of file