summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGeorgios Andreadis <g.andreadis@student.tudelft.nl>2017-04-04 18:17:14 +0200
committerGeorgios Andreadis <g.andreadis@student.tudelft.nl>2017-04-04 18:17:14 +0200
commit044874053e06e9abf255bb4d0c547cfe31fcc21a (patch)
tree079dcf0a8c1e270df4fc37713ad674e2315ad469 /README.md
parent45dd33b3cd84aab455dafb81e877a421959f4a59 (diff)
Improve build documentation in README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/README.md b/README.md
index 5248c5c1..4f226d10 100644
--- a/README.md
+++ b/README.md
@@ -56,19 +56,19 @@ git clone --recursive https://github.com/atlarge-research/opendc.git
cd opendc/
```
-In the directory you just entered, you need to set up a small configuration file. To do this, create a file called `keys.json` in the `opendc` folder. In this file, simply replace `your-google-oauth-client-id` with your `client_id` from the OAuth client ID you created.
+In the directory you just entered, you need to set up a small configuration file. To do this, create a file called `keys.json` in the `opendc` folder. In this file, simply replace `your-google-oauth-client-id` with your `client_id` from the OAuth client ID you created. For a standard setup, you can leave the other settings as-is.
```json
{
+ "DATABASE_LOCATION": "/data/database/opendc.db",
+ "FLASK_SECRET": "This is a super duper secret flask key",
"OAUTH_CLIENT_ID": "your-google-oauth-client-id",
- "SERVER_BASE_URL": "http://localhost:8081",
"ROOT_DIR": "/opendc",
- "FLASK_SECRET": "This is a super duper secret flask key",
- "DATABASE_LOCATION": "/data/database/opendc.db"
+ "SERVER_BASE_URL": "http://localhost:8081"
}
```
-Once this configuration file is set up, we're ready to get the install up and running:
+Now, start the server:
```bash
# Build the Docker image