summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMS <ms@taler.net>2023-12-11 19:57:47 +0100
committerMS <ms@taler.net>2023-12-11 19:57:47 +0100
commit579d93541d44ef63ef036c565d7626c76cd80d8b (patch)
treeefb6cf61bfdfc10a1e861a23e4cf47934f80ff3c
parent29918880f335aff089a91b52716e24cea1199c9d (diff)
downloaddeployment-579d93541d44ef63ef036c565d7626c76cd80d8b.tar.gz
deployment-579d93541d44ef63ef036c565d7626c76cd80d8b.tar.bz2
deployment-579d93541d44ef63ef036c565d7626c76cd80d8b.zip
regional setup: rename to address any currency
-rw-r--r--netzbon/README144
-rw-r--r--regional-currency/.gitignore (renamed from netzbon/.gitignore)0
-rw-r--r--regional-currency/.shellcheckrc (renamed from netzbon/.shellcheckrc)0
-rw-r--r--regional-currency/README2
-rwxr-xr-xregional-currency/config_libeufin.sh (renamed from netzbon/config_libeufin.sh)0
-rwxr-xr-xregional-currency/config_libeufin_bank.sh (renamed from netzbon/config_libeufin_bank.sh)0
-rwxr-xr-xregional-currency/config_libeufin_nexus.sh (renamed from netzbon/config_libeufin_nexus.sh)0
-rwxr-xr-xregional-currency/config_nginx.sh (renamed from netzbon/config_nginx.sh)0
-rwxr-xr-xregional-currency/functions.sh (renamed from netzbon/functions.sh)0
-rw-r--r--regional-currency/incoming_template.xml (renamed from netzbon/incoming_template.xml)0
-rwxr-xr-xregional-currency/install_packages.sh (renamed from netzbon/install_packages.sh)0
-rwxr-xr-xregional-currency/main.sh (renamed from netzbon/main.sh)0
-rw-r--r--regional-currency/nginx-conf/backend.taler-nginx.conf (renamed from netzbon/nginx-conf/backend.taler-nginx.conf)0
-rw-r--r--regional-currency/nginx-conf/bank.taler-nginx.conf (renamed from netzbon/nginx-conf/bank.taler-nginx.conf)0
-rw-r--r--regional-currency/nginx-conf/exchange.taler-nginx.conf (renamed from netzbon/nginx-conf/exchange.taler-nginx.conf)0
-rwxr-xr-xregional-currency/setup-exchange.sh (renamed from netzbon/setup-exchange.sh)0
-rwxr-xr-xregional-currency/setup-merchant.sh (renamed from netzbon/setup-merchant.sh)0
-rwxr-xr-xregional-currency/transfer.sh (renamed from netzbon/transfer.sh)0
-rw-r--r--regional-currency/vagrant/.gitignore (renamed from netzbon/vagrant/.gitignore)0
-rw-r--r--regional-currency/vagrant/README (renamed from netzbon/vagrant/README)0
-rw-r--r--regional-currency/vagrant/Vagrantfile (renamed from netzbon/vagrant/Vagrantfile)0
-rwxr-xr-xregional-currency/withdraw.sh (renamed from netzbon/withdraw.sh)0
22 files changed, 2 insertions, 144 deletions
diff --git a/netzbon/README b/netzbon/README
deleted file mode 100644
index d2fb5c7..0000000
--- a/netzbon/README
+++ /dev/null
@@ -1,144 +0,0 @@
-=====================================
-Taler @ NetzBon deployment automation
-=====================================
-
-This directory contains a set of scripts for deploying Taler by asking
-questions to the user and providing the values to the various Taler subsystems
-(LibEufin, Exchange, Merchant, ..) and other components (nginx, systemd).
-
-main.sh is the entry point script for the Taler setup. It asks the questions
-and puts the answers in environment variables and/or replaces them into Nginx
-configuration file(s).
-
-The main.sh script can be re-run whenever the setup process was interrupted,
-for example due to problems (domain name setup, etc.) that the admin needs to
-fix first.
-
-Getting Started
-===============
-
-The setup scripts are currently only tested on Ubuntu Kinetic Kudu.
-
-Start by cloning the deployment.sh repository:
-
-$ git clone git://taler.net/deployment.git
-
-Proceed with the setup by executing the main.sh script:
-
-$ cd deployment/netzbon
-$ ./main.sh
-
-After the setup is complete, you can:
-- go to https://bank.$domain/, log in as admin
- and create the first (merchant) bank account(s)
-- fund one of the accounts (see section "Funding of bank accounts"),
- so that withdrawal can be tested
-- log into the bank with the funded (non-admin) account, withdraw electronic
- cash via the bank UI into the Taler wallet (either browser extension wallet
- or Android wallet)
-- go to the merchant backoffice (https://backend.$domain/),
- log in, configure the instance (do not forget to set an access token),
- create the first order and pay for it with the wallet.
-
-
-Domain names
-============
-
-Assuming a main domain at netzbon.ch (i.e. "netzbon.ch" will be given as the
-value for the domain during configuration), this setup expects the following
-subdomains to be reachable:
-
-- exchange.netzbon.ch
-- bank.netzbon.ch
-- backend.netzbon.ch (merchants frontends need this)
-
-
-Setup guide
-===========
-
-The following recommendations apply for questions from the "main.sh" script:
-
-- "Run taler-exchange-offline?"
- => Answer with "yes", otherwise manual offline key management
- has to be done by the sysadmin.
-- TLS: yes, as long as the domain is externally reachable for letsencrypt
-
-When packages are installed, the package manager will ask questions about the
-database configuration:
-- "Configure database for XZY with dbconfig-common?"
- => Should be answered with "yes"
-- "Please select the remote hostname to use"
- => Select "localhost"
-- "PostgreSQL application password"
- => Should be left blank, so that installer will use secure random password.
-
-
-Funding of bank accounts
-========================
-
-After a successful installation, all the services are running
-and the administrator can create bank accounts and wire funds
-to them. The script "transfer.sh" in this directory serves this
-purpose; running it without arguments shows the usage instructions.
-
-Note: The wiring of funds causes the amount to be subtracted from the "admin"
-bank account. Following is one example of wiring funds from the administrator
-to the "shop" bank account.
-
- $ ./transfer.sh shop NETZBON:10 "welcome amount"
-
-If the command succeeded, the 'shop' bank account has received
-one payment of 10 NETZBONs from 'admin' with the subject "welcome
-amount".
-
-Concept
-=======
-
-The different stages of the installation have their own shell
-scripts, driven by the 'main.sh' master script. Splitting up the
-process into the main stages should make it easy to resume if any
-particular step fails for any reason.
-
-The different stages communicate via environment variables which
-they may consume or export for future stages. The 'main.sh' script
-prompts the user for the following inputs:
-
-* the main domain name (subdomains may be created automatically)
-* the name of the currency
-* the master password to set for the administrative Web interface
-
-The setup is fundamentally based on the Debian packages. The scripts
-should do the minimal amount necessary to get GNU Taler to work on top
-of what the Debian packages provide. If we can move logic into a Debian
-package, we should. However, the Debian packages MUST install non-interactively
-[NOTE: they do for the DB config], so site-specific inputs MUST be
-done by the shell scripts.
-
-The shell scripts should be kept simple, and for example use default
-configuration(s) from the Debian packages and replace values with 'sed'
-instead of generating complete configurations themselves (where possible,
-so in particular for the reverse HTTPS proxy configuration).
-
-
-Components
-==========
-
-The goal is not to only setup the Debian packages, but to also configure
-all of the components:
-
-* libeufin-bank with an account for the administrator and the exchange
-* libeufin-nexus with access to the exchange account and Taler facade
-* exchange with denominations, fees (all zero) and credentials for the libeufin-nexus
-* merchant backend with the master key of the exchange for the target currency
-
-
-Future
-======
-
-For now, it is assumed that the taler-exchange-offline functionality is run
-locally (in a system that is online). Future deployments should aim at moving
-the offline keys in a offline system.
-
-For now, we do not integrate the currency conversion / cash out logic and
-only have libeufin-nexus between libeufin-sandbox and exchange. In the future,
-nexus will also communicate with an external bank.
diff --git a/netzbon/.gitignore b/regional-currency/.gitignore
index 4492389..4492389 100644
--- a/netzbon/.gitignore
+++ b/regional-currency/.gitignore
diff --git a/netzbon/.shellcheckrc b/regional-currency/.shellcheckrc
index e170f39..e170f39 100644
--- a/netzbon/.shellcheckrc
+++ b/regional-currency/.shellcheckrc
diff --git a/regional-currency/README b/regional-currency/README
new file mode 100644
index 0000000..599336a
--- /dev/null
+++ b/regional-currency/README
@@ -0,0 +1,2 @@
+Refer to the following document:
+https://docs.taler.net/libeufin/regional-manual.html#guided-basic-setup
diff --git a/netzbon/config_libeufin.sh b/regional-currency/config_libeufin.sh
index ee9e707..ee9e707 100755
--- a/netzbon/config_libeufin.sh
+++ b/regional-currency/config_libeufin.sh
diff --git a/netzbon/config_libeufin_bank.sh b/regional-currency/config_libeufin_bank.sh
index 5a32844..5a32844 100755
--- a/netzbon/config_libeufin_bank.sh
+++ b/regional-currency/config_libeufin_bank.sh
diff --git a/netzbon/config_libeufin_nexus.sh b/regional-currency/config_libeufin_nexus.sh
index 491a757..491a757 100755
--- a/netzbon/config_libeufin_nexus.sh
+++ b/regional-currency/config_libeufin_nexus.sh
diff --git a/netzbon/config_nginx.sh b/regional-currency/config_nginx.sh
index 2fe561c..2fe561c 100755
--- a/netzbon/config_nginx.sh
+++ b/regional-currency/config_nginx.sh
diff --git a/netzbon/functions.sh b/regional-currency/functions.sh
index a596f72..a596f72 100755
--- a/netzbon/functions.sh
+++ b/regional-currency/functions.sh
diff --git a/netzbon/incoming_template.xml b/regional-currency/incoming_template.xml
index 635fca7..635fca7 100644
--- a/netzbon/incoming_template.xml
+++ b/regional-currency/incoming_template.xml
diff --git a/netzbon/install_packages.sh b/regional-currency/install_packages.sh
index 76ab05b..76ab05b 100755
--- a/netzbon/install_packages.sh
+++ b/regional-currency/install_packages.sh
diff --git a/netzbon/main.sh b/regional-currency/main.sh
index 97773ea..97773ea 100755
--- a/netzbon/main.sh
+++ b/regional-currency/main.sh
diff --git a/netzbon/nginx-conf/backend.taler-nginx.conf b/regional-currency/nginx-conf/backend.taler-nginx.conf
index 3e20704..3e20704 100644
--- a/netzbon/nginx-conf/backend.taler-nginx.conf
+++ b/regional-currency/nginx-conf/backend.taler-nginx.conf
diff --git a/netzbon/nginx-conf/bank.taler-nginx.conf b/regional-currency/nginx-conf/bank.taler-nginx.conf
index 9e2ce5b..9e2ce5b 100644
--- a/netzbon/nginx-conf/bank.taler-nginx.conf
+++ b/regional-currency/nginx-conf/bank.taler-nginx.conf
diff --git a/netzbon/nginx-conf/exchange.taler-nginx.conf b/regional-currency/nginx-conf/exchange.taler-nginx.conf
index 0f470a1..0f470a1 100644
--- a/netzbon/nginx-conf/exchange.taler-nginx.conf
+++ b/regional-currency/nginx-conf/exchange.taler-nginx.conf
diff --git a/netzbon/setup-exchange.sh b/regional-currency/setup-exchange.sh
index 2c4c06f..2c4c06f 100755
--- a/netzbon/setup-exchange.sh
+++ b/regional-currency/setup-exchange.sh
diff --git a/netzbon/setup-merchant.sh b/regional-currency/setup-merchant.sh
index 917e653..917e653 100755
--- a/netzbon/setup-merchant.sh
+++ b/regional-currency/setup-merchant.sh
diff --git a/netzbon/transfer.sh b/regional-currency/transfer.sh
index d49d445..d49d445 100755
--- a/netzbon/transfer.sh
+++ b/regional-currency/transfer.sh
diff --git a/netzbon/vagrant/.gitignore b/regional-currency/vagrant/.gitignore
index 8000dd9..8000dd9 100644
--- a/netzbon/vagrant/.gitignore
+++ b/regional-currency/vagrant/.gitignore
diff --git a/netzbon/vagrant/README b/regional-currency/vagrant/README
index e9387d3..e9387d3 100644
--- a/netzbon/vagrant/README
+++ b/regional-currency/vagrant/README
diff --git a/netzbon/vagrant/Vagrantfile b/regional-currency/vagrant/Vagrantfile
index 7cb3574..7cb3574 100644
--- a/netzbon/vagrant/Vagrantfile
+++ b/regional-currency/vagrant/Vagrantfile
diff --git a/netzbon/withdraw.sh b/regional-currency/withdraw.sh
index 850d343..850d343 100755
--- a/netzbon/withdraw.sh
+++ b/regional-currency/withdraw.sh