commit a9b6ec2c6af0d9ac2a46ced1f5bbd1b95bfcd229
parent 46cb068542759eb5e79ef0ac494261a18b065044
Author: Javier Sepulveda <javier.sepulveda@uv.es>
Date: Sun, 6 Aug 2023 14:48:35 +0200
Removing docker-compose dashes and fixing line breaks
Diffstat:
1 file changed, 21 insertions(+), 15 deletions(-)
diff --git a/sandcastle/README b/sandcastle/README
@@ -14,7 +14,7 @@ point the bank SPA to any backend not being served at bank.demo.taler.net.
How to compile
==============
-The base image (not managed by the docker-compose setup) and
+The base image (not managed by the docker compose setup) and
all the other images must be compiled.
Base image
@@ -32,7 +32,7 @@ Composed containers
From this directory, run:
- $ docker-compose build
+ $ docker compose build
Hotfixes
--------
@@ -66,8 +66,8 @@ belonging to the compose file. Note that such image may
easily fail because it likely relies on other images not
being run.
-$ docker-compose build $image-name # if also new changes need to be tested.
-$ docker-compose up $image-name
+$ docker compose build $image-name # if also new changes need to be tested.
+$ docker compose up $image-name
'bank', 'exchange', 'merchant', 'talerdb' are valid values
for $image-name.
@@ -105,7 +105,7 @@ Run
The following command starts all the services in the background,
and manages all the restarts. Run it from this directory:
- $ docker-compose up --remove-orphans -d
+ $ docker compose up --remove-orphans -d
The ports exposed on the host by each service can be changed
via the following environment variables:
@@ -128,15 +128,15 @@ for debugging.
On a daemonized setup, live logs can still be seen by running
the following command from this directory:
- $ docker-compose logs --tail=$NUM --follow [container-name]
+ $ docker compose logs --tail=$NUM --follow [container-name]
To stop the services, run the following command from this directory:
- $ docker-compose stop
+ $ docker compose stop
To start the services in the foreground, run the following command
from this directory (no restart is provided):
- $ docker-compose up --remove-orphans --abort-on-container-exit
+ $ docker compose up --remove-orphans --abort-on-container-exit
Volumes
-------
@@ -165,7 +165,7 @@ Data can be classified between Taler (DBs, keys, logs), and Docker specific
in 'volumes', and can be removed in the following way:
# From this directory.
- $ docker-compose down -v
+ $ docker compose down -v
Note: the current version does not store config files into volumes, but in
services' containers.
@@ -205,7 +205,8 @@ NOTE: localhost works only with the default ports exposed.
How to deploy to online sites
=============================
-Before deploying the sandcastle setup, you need to undertake certain replacements within the configuration file "config/deployment.conf".
+Before deploying the sandcastle setup, you need to undertake certain replacements within
+the configuration file "config/deployment.conf".
currency = KUDOS (or the name of your currency)
merchant-url = https://backend.yourdomain.com
@@ -217,21 +218,26 @@ sync-url = https://sync.yourdomain.com/
bank-url = https://bank.yourdomain.com/
bank-backend-url = https://bank.yourdomain.com/demobanks/default/
-After doing this, and assuming that TLS is already configured, you can use the file named "nginx-example.conf" on the sandcastle directory,
-as a NGINX virtual host, replacing the domain name "example.com" with your own domain name.
+After doing this, and assuming that TLS is already configured, you can use the file named
+"nginx-example.conf" on the sandcastle directory, as a NGINX virtual host, replacing
+the domain name "example.com" with your own domain name.
-You can use the the SED command to replace this automatically as this, being located within the sandcastle directory beforehand:
+You can use the the SED command to replace this automatically as this, being located within
+ the sandcastle directory beforehand:
sed -i "s/example.com/yourdomain.com/g" nginx-example.conf
TLS Configuration
===================
-For the sake of simplicity we recommend CERBOT as a mean to obtain the Let's Encrypt certificates.
+For the sake of simplicity we recommend CERBOT as a mean to obtain the Let's Encrypt
+certificates.
First intall the CERTBOT program following the instructions from https://certbot.eff.org/
-After you have correctly installed CERTBOT, just execute "certbot --nginx" to obtain the necessary certificates to use the https protocol, and have them renewed automatically every 90 days.
+After you have correctly installed CERTBOT, just execute "certbot --nginx" to obtain
+the necessary certificates to use the https protocol, and have them renewed automatically
+ every 90 days.
