regional-automated-manual.rst (11421B)
1 .. 2 This file is part of GNU TALER. 3 Copyright (C) 2014-2024 Taler Systems SA 4 5 TALER is free software; you can redistribute it and/or modify it under the 6 terms of the GNU Affero General Public License as published by the Free Software 7 Foundation; either version 2.1, or (at your option) any later version. 8 9 TALER is distributed in the hope that it will be useful, but WITHOUT ANY 10 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR 11 A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. 12 13 You should have received a copy of the GNU Affero General Public License along with 14 TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> 15 16 @author Florian Dold 17 @author Marcello Stanisci 18 @author Christian Grothoff 19 20 21 .. target audience: operator 22 23 Regional Currency Automated Setup Manual 24 ######################################## 25 26 This manual describes how to setup a regional currency using a script that largely automates the process. If you want to do a custom setup you can follow the :doc:`custom setup manual<regional-custom-manual>`. 27 28 .. include:: ../frags/regional-manual-architecture.rst 29 30 Guided Automated Setup 31 ====================== 32 33 Prerequisites 34 +++++++++++++ 35 36 For this manual, we assume that the system is deployed on a contemporary 37 Debian GNU/Linux Bookworm or Ubuntu Mantic system using the binary packages provided. 38 Furthermore, you should run the process on a system with one or more globally 39 reachable IP address(es) *and* with various DNS names already pointing to 40 these IPs. 41 42 Preparing the required subdomain names 43 ++++++++++++++++++++++++++++++++++++++ 44 45 The GNU Taler program needs to have three subdomains pointing to your server IP address, in order to let NGINX to accommodate each component. 46 These are "bank", "exchange" and "backend", this said, you need to have a registered top level domain name, 47 where you can create type (A) entries, as subdomains pointing to your own server public IP address. 48 A very good advice when creating these subdomains, and if your domain panel lets you specify the TTL (time to live) figure, is 49 to specify a very low value (such as 300), so in case of future changes, its value (the IP address), will be propagated quickly. 50 51 Once you have added the three required subdomains in your domain control panel, you have to make sure as well, these subdomains have 52 propagated over the Internet correctly, and they are currently publicly available. 53 54 You can check this from your terminal very easily with the "ping" command, as this: 55 56 .. code-block:: console 57 58 $ ping -c1 bank.$DOMAIN_NAME 59 $ ping -c1 exchange.$DOMAIN_NAME 60 $ ping -c1 backend.$DOMAIN_NAME 61 62 You can also use `this tool <https://toolbox.googleapps.com/apps/dig/>`_ for the same purpose, and to check the propagation status. 63 64 .. warning:: 65 Take into account some hosting providers providing virtualized servers (VPS or VDS) can enable by default the firewall program "UFW", blocking by default the port number 443. So you have to either disable this firewall program, or open to this 443 port number to allow https. 66 67 Now you are ready to go with the next step. 68 69 Obtaining the Scripts 70 +++++++++++++++++++++ 71 72 First, download the deployment scripts via Git: 73 74 .. code-block:: console 75 76 # apt update && apt install git 77 $ git clone git://git.taler.net/taler-deployment 78 79 Running the Guided Configuration 80 ++++++++++++++++++++++++++++++++ 81 82 Navigate into the *regional-currency/* directory and run *main.sh* as **root**: 83 84 .. code-block:: console 85 86 $ cd taler-deployment/regional-currency/ 87 # ./main.sh 88 89 The script will start by installing the required packages and then asking you fundamental questions about the desired setup, in particular: 90 91 #. Wether to encrypt, when stored on disk, sensible configurations such as the admin password. 92 #. The name of the regional currency. It must have 3 to 11 letters. 93 #. Whether to setup the regional currency to be backed by a fiat currency. You'll need a bank account at a fiat currency bank offering an online banking protocol supported by LibEuFin Nexus. If you answer ``y``, you will also need to provide the following information: 94 95 #. The ISO code of the fiat currency. Use 'CHF' or 'EUR'. 96 #. The IBAN of the fiat bank account. 97 #. The BIC of the fiat bank account. 98 #. The legal name of the fiat bank account. 99 100 #. The name of the regional currency bank. It will be shown to business users when they interact with the system. 101 #. The DNS domain name of your setup (i.e: domain.tld). The installer will create by itself all the needed subdomains for your domain name, as (``bank.$DOMAIN_NAME``, ``exchange.$DOMAIN_NAME`` and ``backend.$DOMAIN_NAME``). But, these subdomain names as explained before, must have been added beforehand to your DNS domain control panel, and they must be pointing to the IP address of the server on which you are running the installation (before you execute the installer). 102 #. Whether to use TLS or not. You should answer ``y`` in most cases. 103 #. 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. 104 #. The admin password for the bank. Be absolutely sure to enter a very, very long and high-entropy password, preferably using the autogenerated one. 105 #. Whether to generate terms of service (ToS) for the exchange from default templates. 106 #. Whether to generate a privacy policy for the exchange from default templates. 107 108 The information you entered as well as the generated bank admin password will 109 be stored in a file called ``config/user.conf``. If you run the script in 110 the future again (for example, to upgrade the installation), you will not be asked 111 these questions a second time. 112 113 After answering all of the questions, the actual installation will start. The 114 scripts will download and configure various packages, which may take some time. 115 Grab a coffee. 116 117 .. note:: 118 119 At this point, the setup is NOT connected to any fiat bank account! The next 120 steps must always be done manually! 121 122 Running the script again from scratch 123 +++++++++++++++++++++++++++++++++++++ 124 125 If for some reason your installation doesn't work because you have answered erroneously 126 some of the interactive questions, or you just want to reset the current installation and to re-deploy 127 the script again for having its latest changes, you will have to proceed as follows: 128 129 In brief, you need to wipe completely the "content" of the file config/user.conf, this doesn't mean 130 to remove the file itself, but only its content. Even though you can do this manually by editing the file manually 131 with your preferred text editor, you can also do this in one single command. 132 133 .. code-block:: console 134 135 # rm config/user.conf 136 137 .. note:: 138 139 In future versions of the program when executed for the second time, the program itself will 140 show an option to offer wiping the content of this config/user.conf file, automatically. 141 142 Multi-factor authentication 143 +++++++++++++++++++++++++++ 144 145 The script allows you to configure multi-factor authentication via SMS using Telesign as a provider. You can also configure multi-factor authentication via email or use providers other than Telesign for SMS. You will need to configure these channels manually as described in :ref:`multi-factor authentication <libeufin-mfa>`. 146 147 If you choose not to back your regional currency with a fiat currency, you can stop here. 148 149 Web-based Configuration 150 +++++++++++++++++++++++ 151 152 By default, the regional currency conversion rates are 1:1. You can change the conversion rates and the ``admin`` debt limit via the bank's web interface as the ``admin`` user. 153 154 Connecting to a Fiat Bank: the EBICS setup 155 ++++++++++++++++++++++++++++++++++++++++++ 156 157 To complete the conversion setup, you have to set up an EBICS subscriber using the fiat bank account you specified during the automated setup. 158 159 When you sign up for an EBICS-enabled bank account, the bank will provide you 160 with various credentials. Those must be provided in the 161 ``/etc/libeufin/libeufin-nexus.conf`` configuration file. 162 163 .. note:: 164 As legacy transactions in that bank account would likely confuse the system, it is advisable to use a fresh bank account with an empty transaction history. 165 If this is not possible, use the ``IGNORE_TRANSACTIONS_BEFORE`` configuration to ignore old transactions. 166 167 The following snippet shows the mandatory configuration values: 168 169 .. _nexus-core-config: 170 171 .. code-block:: ini 172 173 [nexus-ebics] 174 # Bank 175 HOST_BASE_URL = https://ebics.postfinance.ch/ebics/ebics.aspx 176 BANK_DIALECT = postfinance 177 178 # EBICS IDs 179 HOST_ID = PFEBICS 180 USER_ID = PFC00563 181 PARTNER_ID = PFC00563 182 183 .. warning:: 184 This combination of HOST_ID, USER_ID and PARTNER_ID must never be used by another instance of libeufin-nexus or by other EBICS clients, otherwise data will be lost. 185 186 Reuse existing client keys 187 ^^^^^^^^^^^^^^^^^^^^^^^^^^ 188 189 If you have client keys from a previous EBICS setup you can copy the JSON file to ``/var/lib/libeufin-nexus/client-ebics-keys.json``. 190 191 Make sure this file is accessible to the user running ``libeufin-nexus``, you should run: 192 193 .. code-block:: console 194 195 $ chown libeufin-nexus:libeufin-nexus /var/lib/libeufin-nexus/client-ebics-keys.json 196 197 Create new client keys 198 ^^^^^^^^^^^^^^^^^^^^^^ 199 200 Run the following command to start the EBICS setup process: 201 202 .. code-block:: console 203 204 $ sudo -u libeufin-nexus libeufin-nexus ebics-setup 205 206 If the previous command failed when running EBICS INI with an error code of 207 ``EBICS_INVALID_USER_OR_USER_STATE``, you need to confirm your keys to your bank to 208 activate your account. 209 210 To that end, the previous run should have left a PDF document that you can 211 print, sign and send to the bank. Look for the message that looks like ``PDF 212 file with keys created at '/tmp/libeufin-nexus-keys-$TIMESTAMP.pdf'``. 213 214 Once the bank has received and processed this document you can continue. 215 216 Get bank keys 217 ^^^^^^^^^^^^^ 218 219 Run the following command to finish the EBICS setup process: 220 221 .. code-block:: console 222 223 $ sudo -u libeufin-nexus libeufin-nexus ebics-setup 224 225 The EBICS setup is finished once the bank keys have been accepted. 226 227 228 Configuring the Exchange for Conversion 229 +++++++++++++++++++++++++++++++++++++++ 230 231 In our automated setup the second account is automatically set up correctly 232 without fees or special restrictions. However, various additional 233 *restrictions* and *options* could be configured. Details are explained in 234 the :ref:`regional conversion setup <regional-conversion-setup>` section for the 235 manual setup and in the the manpage of ``taler-exchange-offline``. 236 237 238 .. include:: ../frags/regional-system-on.rst 239 .. include:: ../frags/deploying-tos.rst 240 241 242 Installing Updates 243 ++++++++++++++++++ 244 245 The standard procedure for installing updates is to: 246 247 * First, make a backup (!) 248 * Stop Taler services 249 * Install new version 250 * Upgrade databases 251 * Start Taler services 252 253 The "upgrade.sh" script in the "regional-currency/" folder of "deployment.git" 254 shows how to do the above steps *except* for the backup. For the backup, all 255 critical bits of data will be in the Postgresql databases. Thus, we recommend 256 following the database manual on making backups.