update readme

Author: mikelduke

README.md

@@ -1,10 +1,11 @@
 # phpGPS
+
 A php based webservice for GPS tracking with Google Maps integration
+
 ========
 
 www.mikelduke.com
 
-
 *******************************************************************************
 A php based webservice for GPS tracking with Google Maps integration
 
@@ -17,8 +18,8 @@ https://developers.google.com/maps/documentation/embed/get-api-key
 
 *******************************************************************************
 
-
 ## Features
+
 * Stores gps coordinates in a MySQL database, generates xml, and draws markers on to a Google Maps map.
 * Draw Paths on the map using the gps entries
 * Paths can be colored
@@ -32,34 +33,58 @@ https://developers.google.com/maps/documentation/embed/get-api-key
 * To embed on a webpage: 
 ```<iframe src="view.php" height="520" width="520" seamless></iframe>```
 
-Example Update URL:
-	http://yoursite.com/phpGPS/addGpsEntry.php?key=1234&newEntry=Y&gps_devicename=DeviceID&gps_type_id=1&gps_path_id=1&gps_date_dt=11-13-2014&gps_date_time=22.31&gps_status=&gps_latitude=32&gps_longitude=-96&gps_altitude=160.0&gps_accuracy=57&gps_name=test%20spot&gps_comment=test%20comment&gps_address1=address%201&gps_address2=address%202&gps_address3=address%203&gps_city=city&gps_zipcode=567567&gps_state=state&gps_country=country
+Example Update URL:  
+    `http://yoursite.com/phpGPS/addGpsEntry.php?key=1234&newEntry=Y&gps_devicename=DeviceID&gps_type_id=1&gps_path_id=1&gps_date_dt=11-13-2014&gps_date_time=22.31&gps_status=&gps_latitude=32&gps_longitude=-96&gps_altitude=160.0&gps_accuracy=57&gps_name=test%20spot&gps_comment=test%20comment&gps_address1=address%201&gps_address2=address%202&gps_address3=address%203&gps_city=city&gps_zipcode=567567&gps_state=state&gps_country=country`
+
+*******************************************************************************
 
 ## Important Pages
+
 * phpGPS_Settings.php   - Settings File
 * generateXML.php       - Generates xml for use by google maps
 * view.php              - Displays the map with markers, embeddedable in an iframe
 
-
 ## Requirements
+
 * php 5+
 * MySQL
 * Webserver
 
+*******************************************************************************
 
 ## Install Instructions
+
 1. Extract php files to webhost
 1. Create Database for use by phpGPS
-1. Enter database settings and other config in phpGPS_Settings.php
+1. Enter database settings and other config in phpGPS_Settings.php or set using environment variables
 1. Open phpGPS/install/install.php in browser to create the necessary tables
 1. Delete the install folder on webhost
 1. Login as user admin/admin and change the default admin pass
 1. Set up owners, devices, paths, etc as desired and start creating markers
 
-# Demo VM
+### Demo VM
+
 Requires Vagrant + VM Provider like VirtualBox + Google Maps API Key
+
 * Clone this repo and make sure .sh files use unix line endings LF
 * Set API Key in phpGPS_Settings.php
 * Run ```vagrant up```
-* Connect at http://localhost
+* Connect at `http://localhost`
+* Login with user/password: admin/admin
+
+*******************************************************************************
+
+## Development
+
+Dockerfile and Docker-compose configs are included for easy setup on Linux/Mac. Windows + Docker is not as seamless.
+
+Use `docker-compose up` to automatically load a basic mysql server and an apache+php server.
+The application is mounted as a volume to allow for modifying php scripts without restarts.
+
+* Install docker and docker-compose if not already present `sudo apt install docker docker-compose`
+* Clone this repo, ensure Unix line endings are used
+* Set api key in shell `export DEV_KEY=1234567890`
+* Launch with `docker-compose up`
+* Connect at `http://localhost:8080`
 * Login with user/password: admin/admin
+* Control+C or `docker-compose down` to stop

docker-compose.yaml

@@ -11,7 +11,7 @@ services:
      - DB_NAME=phpgps
      - DB_USER=phpgps
      - DB_PASSWORD=password
-     - DEV_KEY # set dev key here or set as envvar on local machine to passthrough
+     - DEV_KEY # set dev key here or export as envvar on local machine to passthrough
     networks:
       - test
   mysql: