From 36f0037000cd802ca1a7238a7508b0f1078a65de Mon Sep 17 00:00:00 2001 From: Jonathan Rosenbaum Date: Sat, 5 May 2018 19:40:40 -0400 Subject: [PATCH] Updated Installation (markdown) --- Installation.md | 27 +++++++++++++++++++++++---- 1 file changed, 23 insertions(+), 4 deletions(-) diff --git a/Installation.md b/Installation.md index c18ca8d..7f27c0a 100644 --- a/Installation.md +++ b/Installation.md @@ -4,15 +4,33 @@ Make sure you have installed time zone support for mysql or mariadb as explained `mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql` -## It is recommended that you install this software with Docker. +### It is recommended that you install this software with Docker. The [Dockerfile](https://github.com/fspc/ybdb/blob/master/Dockerfile) may be found at [https://github.com/fspc/ybdb](https://github.com/fspc/ybdb). If you would prefer not to use Docker, you can follow the steps in the [Dockerfile](https://github.com/fspc/ybdb/blob/master/Dockerfile) to perform a manual install. You may pull the repository (updated infrequently) from the [Docker Hub Registry](https://hub.docker.com/r/bikebike/ybdb/) with this command: +## How to install with docker-compose + +Run `docker-compose pull` and then `docker-compose up -d`. By default, your container will be available on port 88. + +## 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, after changing `port` in docker-compose.yml from `88:80` to `80`: + +###### 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: @@ -20,10 +38,10 @@ Publish the container's port to the host: ``` -docker run -d -p 81:80 --name="ybdb" bikebike/ybdb +docker run -d -p 88:80 --name="ybdb" bikebike/ybdb ``` -### How to test/develop inside the running container process +## How to test/develop inside the running container process ``` sudo docker exec -it ybdb /bin/bash @@ -42,6 +60,7 @@ then do this before attempting again: docker stop ybdb docker start ybdb ``` + ### Etherpad Etherpad is a powerful, useful feature. Complete directions are at [EtherPad / EtherDraw functionality](https://github.com/fspc/etherpad-and-draw-node-alpine), and configurations may be found in [Connections/database_functions.php](https://github.com/fspc/Yellow-Bike-Database/blob/devel/Connections/database_functions.php) (USE Connections/local_configurations.php). \ No newline at end of file