commit b6f6554df1c4f50702fc5af43627aede9ea81bc0
parent 9fa05d70f144fd6c9d84ab269c651090bf1dd65c
Author: MS <ms@taler.net>
Date: Fri, 3 Mar 2023 20:24:53 +0100
fix Docker instructions
Diffstat:
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/libeufin/local-currencies-tutorial.rst b/libeufin/local-currencies-tutorial.rst
@@ -12,7 +12,7 @@ on the :ref:`Circuit API <circuit-api>`. More information
about libEufin can be found in the :doc:`How-To page </libeufin/nexus-tutorial>`.
The following sections show how to install and launch Sandbox
-either `from sources <install-from-sources_>`_, or `with Docker <_docker-setup>`_.
+either `from sources <install-from-sources_>`_, or `with Docker <docker-setup_>`_.
.. _install-from-sources:
@@ -84,30 +84,32 @@ host's port 5000.
.. code-block:: console
- $ docker run -p 5000:5000 -v /libeufin-data:libeufin_data -it nlnet
+ $ docker run -p 5000:5000 -v libeufin_data:/libeufin-data -it nlnet
The previous command uses a default admin password of
'admin' and the NB currency. Do **CHANGE** the admin
password in a production scenario. The following command
-shows how to start the Sandbox with a custom administrator
-password.
+shows how to start the Sandbox with custom administrator
+password and currency (defaults to EUR otherwise).
.. code-block:: console
$ export MY_PASSWORD=secret
- # Add '-e CURRENCY=$MY_CURRENCY' to also set the currency.
- $ docker run -p 5000:5000 -e LIBEUFIN_SANDBOX_ADMIN_PASSWORD=$MY_PASSWORD
+ $ docker run -e LIBEUFIN_SANDBOX_ADMIN_PASSWORD=$MY_PASSWORD -e CURRENCY=NB -v libeufin_data:/libeufin-data -p 5000:5000 -it nlnet
-This setup stores the database in a Docker *volume*. The
-following command therefore shows how to delete the database
-volume, in order to reset all the data.
+This setup stores the database in a Docker *volume*. The following
+command therefore resets all the data stored by LibEuFin.
.. code-block:: console
$ docker volume rm libeufin_data
+Note: the removal might fail because the exited containers
+are seen as still using the container. Please refer to the Docker
+documentation for further information.
+
.. _after-installation:
If Sandbox is running
