From a2cf24d8d03ae6b8fb9f1fc540386672bfe277cf Mon Sep 17 00:00:00 2001 From: Chaz Straney Date: Sun, 4 Aug 2019 21:14:42 -0400 Subject: [PATCH] Add instructions on building with docker-compose Adds instructions on building images via their inclusion in a `docker-compose.yml` and adds clarification on images which require building locally before docker images will build. --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6865d48..7bb0b62 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,18 @@ $ docker build . -t The resulting image can be referred to by the name specified, and run by the containerization tooling of your choice. -Note that some of the components require compilation or other build steps before the docker images can be built. For example, `FrontEnd`: +In order to use a local Dockerfile with `docker-compose`, simply change the `image` option to `build`, setting the value to the relative path of the directory containing the dockerfile. Then run `docker-compose build` to build the relevant images. For example: + +``` +# docker-compose.yml from project root, referencing local dockerfiles +pipeline0: + build: ./Pipeline/ +image: chazu/ambar-pipeline + localcrawler: + image: ./LocalCrawler/ +``` + +Note that some of the components require compilation or other build steps be performed _on the host_ before the docker images can be built. For example, `FrontEnd`: ``` # Assuming a suitable version of node.js is installed (docker uses 8.10)