Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Rearranged and added some detail to the Docker instructions to make them more beginner friendly.
  • Loading branch information
jcgoette authored and cdubz committed Nov 5, 2020
1 parent 187d222 commit b67ccb2
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
the only file needed for a Docker deployment with Docker Compose.

1. Copy the contents of `docker-compose.example.yml` as `docker-compose.yml`
and set, at least, the `ALLOWED_HOSTS` and `SECRET_KEY` variables under
A secondary example file `docker-compose.example.sqlite.yml` is also available
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`.

*See [Configuration](#configuration) for other settings that can be
controlled by environment variables.*
*See [Configuration](#configuration) for other settings that can be controlled by environment variables.*

1. Build/run the application

Expand All @@ -111,9 +121,6 @@ The app should now be locally available at
[Docker's "Get Started" documentation](https://docs.docker.com/get-started/)
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

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
Expand Down

0 comments on commit b67ccb2

Please sign in to comment.