Update README.md

Rearranged and added some detail to the Docker instructions to make them more beginner friendly.
This commit is contained in:
Justin Goette 2020-11-05 14:23:33 -05:00 committed by Christopher Charbonneau Wells
parent 187d2226e0
commit b67ccb2fed
1 changed files with 14 additions and 7 deletions

View File

@ -95,12 +95,22 @@ intended for production deployments. Baby Buddy is deployed to Docker Hub as
[babybuddy/babybuddy](https://hub.docker.com/r/babybuddy/babybuddy) so this is [babybuddy/babybuddy](https://hub.docker.com/r/babybuddy/babybuddy) so this is
the only file needed for a Docker deployment with Docker Compose. the only file needed for a Docker deployment with Docker Compose.
1. Copy the contents of `docker-compose.example.yml` as `docker-compose.yml` A secondary example file `docker-compose.example.sqlite.yml` is also available
and set, at least, the `ALLOWED_HOSTS` and `SECRET_KEY` variables under for a simpler SQLite-based deployment (the default example users PostgreSQL).
1. Copy the raw content of either `docker-compose.example.yml` or `docker-compose.example.sqlite.yml`
into a new file named `docker-compose.yml`
wget https://raw.githubusercontent.com/babybuddy/babybuddy/master/docker-compose.example.yml
*or*
wget https://raw.githubusercontent.com/babybuddy/babybuddy/master/docker-compose.example.sqlite.yml
1. Within `docker-compose.yml`, at the very least, set the `ALLOWED_HOSTS` and `SECRET_KEY` variables under
`services:app:environment`. `services:app:environment`.
*See [Configuration](#configuration) for other settings that can be *See [Configuration](#configuration) for other settings that can be controlled by environment variables.*
controlled by environment variables.*
1. Build/run the application 1. Build/run the application
@ -111,9 +121,6 @@ The app should now be locally available at
[Docker's "Get Started" documentation](https://docs.docker.com/get-started/) [Docker's "Get Started" documentation](https://docs.docker.com/get-started/)
for detailed information about deployment methods with Docker. for detailed information about deployment methods with Docker.
A secondary example file `docker-compose.example.sqlite.yml` is also available
for a simpler SQLite-based deployment (the default example users PostgreSQL).
### Heroku ### Heroku
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)