From 037439c3431000ee0eb04fb7b4879e07b98dcfe4 Mon Sep 17 00:00:00 2001 From: Chaz Date: Wed, 31 Jul 2019 19:32:26 -0400 Subject: [PATCH 1/2] add brief section to readme about building docker images --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 5144add..6865d48 100644 --- a/README.md +++ b/README.md @@ -61,6 +61,26 @@ You can build Docker images by yourself or buy prebuilt Docker images for **$50* If you want to see how Ambar works w/o installing it, try our [live demo](https://app.ambar.cloud/). No signup required. +## Building the images yourself + +All of the images required to run ambar can be built by the user. In general, each image can be built by navigating into the directory of the component in question, performing any compilation steps required, then building the image like so: + +``` +# From project root +$ cd FrontEnd +$ 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`: + +``` +# Assuming a suitable version of node.js is installed (docker uses 8.10) +$ npm install +$ npm run compile +``` + ## FAQ ### Is it open-source? Yes, it's fully open-source. From a2cf24d8d03ae6b8fb9f1fc540386672bfe277cf Mon Sep 17 00:00:00 2001 From: Chaz Straney Date: Sun, 4 Aug 2019 21:14:42 -0400 Subject: [PATCH 2/2] 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)