commit 572118b8b9f731b9c73b283fc2bf277f9e438370
parent 5889ebe349e58c601af8399f6f26f9f6a2cd2c1c
Author: Marcello Stanisci <marcello.stanisci@inria.fr>
Date: Thu, 5 Jan 2017 14:27:06 +0100
Update README
Diffstat:
1 file changed, 14 insertions(+), 13 deletions(-)
diff --git a/docker/README b/docker/README
@@ -1,19 +1,23 @@
-=== Dockerizing the Exchange ===
+=== Dockerizing the Exchange/Merchant ===
-This section shows how to run a "dockerized" exchange.
+This section shows how to run a "dockerized" exchange/merchant.
The exchange uses postgresql (container) and is served
-by nginx (container).
+by nginx (container). The merchant instead depends on exchange
+(container) and postgresql (container).
The docker's tools needed are: docker, docker-compose, docker-machine.
Please refer to Docker's official documentation for their installation
instructions.
-Before starting to build the exchange's image, make sure a docker-machine
-instance is up and running.
+Before starting to build the exchange/merchant's image, make sure a
+docker-machine instance is up and running.
1. Build the images.
-From <THIS_REPO/docker>, give:
+<COMPONENT> is either 'exchange' or 'merchant', depending on what is
+to be built.
+
+From <THIS_REPO/<COMPONENT>/docker>, give:
$ docker-compose build
@@ -22,7 +26,7 @@ and nginx images.
2. Launch the service.
-The following command launches the exchange and all other services
+The following command launches the <COMPONENT> and all other services
it depends on. From the same directory as the previous step, issue:
$ docker-compose up
@@ -34,15 +38,12 @@ PS. Errors about existing roles/databases can be ignored.
3. Test
-Issue the following command to see if the exchange has been correctly
-installed and launched.
+Issue the following command to see if the <COMPONENT> has been
+correctly installed and launched.
+# Some 'greeting' message should be returned.
$ curl http://`docker-machine ip`:80/
-and
-
-$ curl http://`docker-machine ip`:80/keys
-
=== How to use these images ===
This section explains how to (1) build and (2) run individual
