From b837a1e34873a787b4f366717707ac3f7ea0cddf Mon Sep 17 00:00:00 2001 From: V-V Date: Fri, 31 Aug 2018 14:09:48 +0300 Subject: [PATCH] Instructions for building and running OrbitDB containers --- docker/README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docker/README.md diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 0000000..eed1f1d --- /dev/null +++ b/docker/README.md @@ -0,0 +1,26 @@ +# Running OrbitDB code in containers + +[Docker](https://github.com/docker/docker-ce) is a tool for running software in containers ie. OS-level virtualization. This directory contains the needed configuration files to: + +- Build base Docker images for OrbitDB + + +## Base Docker image + +[Dockerfile](Dockerfile) defines OrbitDB base images that are based on [official node.js -image](https://hub.docker.com/_/node/). + +Build local images with command (in repository root): + +```bash +docker build -t orbit-db -f docker/Dockerfile . +``` + +After building local image, run node.js-examples inside container: + +```bash +docker run -ti --rm orbit-db npm run examples:node +``` + +## Tested versions + +- Docker 1.13.1 (Fedora Linux 27)