-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
move populated readme to highest directory level
- Loading branch information
Showing
2 changed files
with
28 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,28 @@ | ||
# mriqcwebapi | ||
Built on: | ||
* [Python Eve](http://python-eve.org/) | ||
* [Python Gunicorn](http://gunicorn.org/) | ||
* [Nginx](https://nginx.org/) | ||
* [Docker](https://www.docker.com/) | ||
|
||
## Run | ||
Example of commands to run locally to start: | ||
```sh | ||
$ cd dockereve-master/ | ||
$ docker-compose build | ||
$ 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 populated the following are the default values: | ||
``` | ||
MONGODB_HOST=mongodb | ||
MONGODB_PORT=27017 | ||
API_TOKEN=<secret_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. |
This file was deleted.
Oops, something went wrong.