summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/README.md b/README.md
index f9df84ae..67e36266 100644
--- a/README.md
+++ b/README.md
@@ -14,12 +14,24 @@ 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 https://github.com/tudelft-atlarge/opendc.git
+
+# Enter the directory
+cd opendc/
+
+# 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]
+