commit 52ca148beb281002ad83f9c13c4f4d38498e1fae
parent 9f6a1be405bf28bd6a2dfc77a7dbac56757ac0f7
Author: Hartmut Goebel <h.goebel@crazy-compilers.com>
Date: Mon, 9 Dec 2024 22:56:41 +0100
Enhance Readme.
Diffstat:
| M | README.md | | | 53 | +++++++++++++++++++++++++++++++++++++++++++++++------ |
1 file changed, 47 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
@@ -39,6 +39,12 @@ port for each of the services.
# Configuring the Deployment
+If you just want to play around with the Taler services inside the container,
+or want to get an integration development environment,
+there is a nice preset, see below.
+Thus in these cases no configuration is required
+and you can skip to "RUnning the Deployment" below.
+
For Taler developers, it is recommended that for each sandcastle deployment,
you clone the sandcastle-ng.git repository
(https://git.taler.net/sandcastle-ng.git) and create a branch with
@@ -59,26 +65,61 @@ To make adjustments for an environment without changing the
beginning of ``setup-sandcastle.sh`` and can be used to customize
environment-specific settings such as hostnames.
-In order to choose an override, set the ``SANDCASTLE_OVERRIDE_NAME`` environment variable
-before running `./sandcastle-run`.
+In order to choose an override,
+set the ``SANDCASTLE_OVERRIDE_NAME`` environment variable
+before running `./sandcastle-run`:
+
+ SANDCASTLE_OVERRIDE_NAME=$YOUR_ENVIRONMENT ./sandcastle-run
+
The following variables are typically adjusted in an override file:
* ``CURRENCY``: Currency of the deployment
* ``MYDOMAIN``: Parent domain name for ``{bank,exchange,backend}`` services.
+* ``EXTERNAL_PORT``: The host port the services will be available on.
+* ``EXTERNAL_IP``: The host IP the services will be available on.
+ For security reasons this defaults to localhost (127.0.0.1).
+* ``USE_INSECURE_SANDBOX_PASSWORDS``:
+ If set to `1`, use password `sandbox` for all services instead of random ones.
+ WARNING! Use only when listening to localhost only!
# Running the Deployment
-Run ``./sandcastle-run`` to run the single container. The container will be
-named taler-sandcastle.
+Run ``./sandcastle-run`` to run the single container.
+The container will be named `taler-sandcastle`.
+On the first run, wait until everything has been set up:
+
+ ./sandcastle-logs
+
+
+Note that ``./sandcastle-run`` is just a wrapper around ``podman run``.
+If required, you can pass addtional arguments to ``./sandcastle-run``.
+These will be passed on to ``podman run``. Example:
-You can run the container in the background by passing ``-d``. Note that ``./sandcastle-run`` is just
-a wrapper around ``podman run``.
+ ./sandcastle-run --log-level=debug
The running container publishes ports to the host as defined in ``./sandcastle-run``.
You can manually verify these port mappings via ``podman port taler-sandcastle``.
+When starting sandcastle like
+
+ SANDCASTLE_OVERRIDE_NAME=taler.localhost ./sandcastle-run
+
+the services will be available as
+
+ - http://taler.localhost:4321
+ - http://bank.taler.localhost:4321
+ - http://shop.taler.localhost:4321
+ - http://donations.taler.localhost:4321
+ - http://backend.taler.localhost:4321 - the merchant backend
+ - http://exchange.taler.localhost:4321
+ - http://auditor.taler.localhost:4321
+ - http://challenger.taler.localhost:4321
+
+This gives a nice environment for integration testing.
+
+
# Stopping the deployment
For stopping the deployment simply run
