From 04e05052910a58790bdabd4e8d4232e5fb3c6e0a Mon Sep 17 00:00:00 2001 From: Sacheendra Talluri Date: Thu, 26 Jan 2017 18:49:38 +0100 Subject: Add build steps to README --- README.md | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 89f554e8..a588089e 100644 --- a/README.md +++ b/README.md @@ -14,12 +14,21 @@ The simulator monitors this `queued_experiments` table, and simulates experiment ## Setup -To build and run the full OpenDC stack locally: +The official way to run OpenDC is using Docker. -First, clone this repository and its submodules: +To build and run the full OpenDC stack locally: ```bash +# Clone the repo and its submodules git clone --recursive git@github.com:tudelft-atlarge/opendc.git + +# Build the Docker image +docker build -t="opendc" . + +# Start a container with the image +docker run -d --name opendc -p 8081:8081 -e 'SERVER_URL=http://localhost:8081' -e 'OAUTH_CLIENT_ID=your-google-oauth-client-id' -e 'OAUTH_CLIENT_SECRET=your-google-oauth-secret' opendc + +# Wait a few seconds and open http://localhost:8081 in your browser ``` -Then... [TO DO] + -- cgit v1.2.3