Skip to content

Commit

Permalink
Update README.md to reflect docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
Michionlion committed Apr 28, 2019
1 parent f0b49f9 commit 59e5a35
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ project, inspect the `[scripts]` tag in `Pipfile`:
cat Pipfile
```

Finally, to run the project locally:
Finally, to run the project locally in development mode:

```
pipenv run server
Expand All @@ -80,6 +80,23 @@ Or use the following to see all the options:
pipenv run python run.py --help
```

## Docker

There is a docker image published to
[gatoreducator/quizagator](https://hub.docker.com/r/gatoreducator/quizagator).
There are two main parts of configuration: specifying a secret in the
`FLASK_SECRET_KEY` environment variable, and forwarding the desired outer port
to `80` inside the container. The following command does both:

```
docker run --name quizagator -p 5000:80 -e FLASK_SECRET_KEY=d2dbb3 gatoreducator/quizagator:0.0.1-dev
```

Additionally, developers can use `pipenv run create-image` and `pipenv run
image` to run a development container -- this is not to be deployed to
production.


## Contributors

Check out our contributors!
Expand Down

0 comments on commit 59e5a35

Please sign in to comment.