From cdb5a55de31fcca1b8215f79a8d46960dcd05277 Mon Sep 17 00:00:00 2001 From: Jonathan Rosenbaum Date: Sat, 5 May 2018 18:33:13 -0400 Subject: [PATCH] adding docker-compose instructions --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c81ad21..1d96e46 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,29 @@ Yellow Bike [Project's](http://austinyellowbike.org) Hours and Transaction [Data Heavily developed [YBP Devel](https://github.com/fspc/Yellow-Bike-Database/tree/devel) is being utilized. -## Pull the repository +## How to Use + +The recommended way is to run `docker-compose up -d`. + +## Advanced environmental changes +The docker-compose.yml file looks for a file called environment. I enjoy using [docker-letsencrypt-nginx-proxy-companion](https://github.com/JrCs/docker-letsencrypt-nginx-proxy-companion), so here is what I add: + +###### environment +``` +VIRTUAL_HOST=ybdb.bikelover.org +LETSENCRYPT_HOST=ybdb.bikelover.org +LETSENCRYPT_EMAIL="jr@bikelover.org" +``` + +## Old Fashioned way + +If you do not want to use docker-compose, you may pull the repository: ``` docker pull bikebike/ybdb ``` -## Run the docker container +Then run the docker container: Publish the container's port to the host: @@ -23,10 +39,6 @@ Publish the container's port to the host: docker run -d -p 81:80 --name="ybdb" bikebike/ybdb ``` -### Status - -Moving along nicely! - ## How to test/develop inside the running container process ```