From 7dcbebc8ec15df94f3e8b1b616739ad3838708e4 Mon Sep 17 00:00:00 2001 From: Ross Blair Date: Tue, 6 Jun 2017 13:46:02 -0700 Subject: [PATCH] update README.md --- dockereve-master/README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/dockereve-master/README.md b/dockereve-master/README.md index 479f408..197223c 100644 --- a/dockereve-master/README.md +++ b/dockereve-master/README.md @@ -5,19 +5,23 @@ Built on: * [Docker](https://www.docker.com/) ## Run +Example of commands to run locally to start: ```sh $ docker-compose build -$ docker-compose up -$ curl -i -H "Content-Type: application/json" http://192.168.99.100:80/T1w +$ docker-compose up -d +$ curl -i -H "Content-Type: application/json" http://localhost/api/v1/T1w ``` Swagger API documentation available at `http://localhost/docs`. ## Environment variables in Docker -To properly run the file dockereve-master/.env needs to be created and populated with the following values: +To properly run the file dockereve-master/.env needs to be populated the following are the default values: ``` -MONGODB_HOST=full url to mongodb host -MONGODB_PORT=port that mongo is running on -API_TOKEN=random string that is used for auth -API_URL=full url to swagger docs in the api +MONGODB_HOST=mongodb +MONGODB_PORT=27017 + +API_TOKEN= +API_URL=http://localhost/docs/api ``` + +If docker is running natively these values should work, otherwise API_URL may need to be updated from localhost accordingly.