[taler-deployment] branch master updated: improve README

[gnunet]

This is an automated email from the git hooks/post-receive script.

dold pushed a commit to branch master
in repository deployment.

The following commit(s) were added to refs/heads/master by this push:
     new 5dd3396  improve README
5dd3396 is described below

commit 5dd33965102d0e8efa1313e239ee3b6972539f4a
Author: Florian Dold <florian@dold.me>
AuthorDate: Thu Mar 16 09:43:15 2023 +0100

    improve README
---
 netzbon/README | 53 ++++++++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 44 insertions(+), 9 deletions(-)

diff --git a/netzbon/README b/netzbon/README
index e6ef156..98372b6 100644
--- a/netzbon/README
+++ b/netzbon/README
@@ -1,11 +1,33 @@
-This directory contains a set of scripts aiming at deploying
-Taler by asking questions to the user and providing the values
-both to the various Taler subsystems (LibEufin, Exchange, Merchant,
-..) and to Nginx.
+=====================================
+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
 
-main.sh is the main script that asks the questions and
-puts the answers in environment variables and/or replaces them
-into Nginx configuration file(s).
 
 Domain names
 ============
@@ -18,6 +40,17 @@ subdomains to be reachable:
 - bank.netzbon.ch
 - backend.netzbon.ch (merchants frontends need this)
 
+
+Setup guide
+===========
+
+The following recommendations apply:
+
+- "Run taler-exchange-offline?"
+  => Answer with "yes", otherwise manual offline key management
+  has to be done by the sysadmin.
+
+
 Funding of bank accounts
 ========================
 
@@ -64,8 +97,9 @@ 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).
 
-Objective
-=========
+
+Components
+==========
 
 The goal is not to only setup the Debian packages, but to also configure
 all of the components:
@@ -75,6 +109,7 @@ all of the components:
 * 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
 ======
 

-- 
To stop receiving notification emails like this one, please contact
gnunet@gnunet.org.