commit e598e76b949425ecb35605b90500e023c934364f parent f2eece62ac6761e129c088be6ac1c37ed4b241ce Author: Florian Dold <florian@dold.me> Date: Fri, 15 Nov 2024 15:58:30 +0100 explain overrides in README Diffstat:
| M | README.md | | | 14 | ++++++++++++++ |
1 file changed, 14 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -35,6 +35,20 @@ The main adjustments to be made are: the host. They can be overwritten with environment variables (``TALER_SANDCASTLE_PORT_$COMPONENT``). +To make adjustments for an environment without changing the +``setup-sandcastle.sh`` script, you can use an override file +``overrides/$YOUR_ENVIRONMENT``. This is a bash script that is sourced at 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`. + +The following variables are typically adjusted in an override file: + +* ``CURRENCY``: Currency of the deployment +* ``MYDOMAIN``: Parent domain name for ``{bank,exchange,backend}`` services. + # Running the Deployment