Merge pull request #9 from mikelduke/docker

Docker and docker-compose

Author: mikelduke

.gitignore

@@ -1,2 +1,3 @@
 .vagrant
 *.log
+dev-key.sh

Dockerfile

@@ -0,0 +1,6 @@
+FROM php:7.3-apache
+
+RUN docker-php-ext-install mysqli && docker-php-ext-enable mysqli
+
+ENV APACHE_RUN_USER=daemon
+COPY src/ /var/www/html/

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

@@ -0,0 +1,33 @@
+version: '3'
+services:
+  phpgps:
+    build: .
+    ports:
+     - "8080:80"
+    volumes:
+     - "./src:/var/www/html/"
+    environment:
+     - DB_HOSTNAME=mysql
+     - DB_NAME=phpgps
+     - DB_USER=phpgps
+     - DB_PASSWORD=password
+     - DEV_KEY # set dev key here or export as envvar on local machine to passthrough
+    networks:
+      - test
+  mysql:
+    image: mysql/mysql-server:8.0
+    hostname: mysql
+    command: --default-authentication-plugin=mysql_native_password
+    ports:
+      - "3306:3306"
+    environment:
+      - MYSQL_ROOT_PASSWORD=root
+      - MYSQL_DATABASE=phpgps
+      - MYSQL_USER=phpgps
+      - MYSQL_PASSWORD=password
+    volumes:
+      - "./sql:/docker-entrypoint-initdb.d/"
+    networks:
+      - test
+networks:
+  test:

sql/CreateTables.sql renamed to sql/1-CreateTables.sql

@@ -1,4 +1,5 @@
 -- Drops tables used in phpGPS
+-- Rename to .sql
 
 drop table users;
 drop table user_types;

sql/InsertTestData.sql renamed to sql/2-InsertTestData.sql

@@ -49,7 +49,9 @@
       $field = phpGPS_DB::cleanInput($key);
       $val = phpGPS_DB::cleanInput($value);
 
-      if ($val != "NULL") $val = "'" . $val . "'";
+      if ($val != "NULL" && $val !== "now()") {
+        $val = "'" . $val . "'";
+      }
       if ($hasValues) {
         $columns = $columns . ", ";
         $values = $values . ", ";

sql/DropTables.sql renamed to sql/DropTables.sql.disabled

@@ -1,9 +1,11 @@
 <?php
 
-  ini_set('display_errors',1);  
-  error_reporting(E_ALL);
+  // enable for development only
+  // ini_set('display_errors',1);  
+  // error_reporting(E_ALL);
 
   class phpGPS_Settings {
+
     //Map Info
     public static $_defaultZoom = 3;
     public static $_defaultCenterLat = "41.988308";
@@ -32,5 +34,28 @@ class phpGPS_Settings {
 
     //Secret key for adding an entry using addGpsEntry.php
     public static $_secretKey = "1234";
+
+
+    // override defaults from environment variables if defined
+    static function init() {
+      phpGPS_Settings::$_host     = phpGPS_Settings::loadFromEnv("DB_HOSTNAME", phpGPS_Settings::$_host);
+      phpGPS_Settings::$_username = phpGPS_Settings::loadFromEnv("DB_USERNAME", phpGPS_Settings::$_username);
+      phpGPS_Settings::$_password = phpGPS_Settings::loadFromEnv("DB_PASSWORD", phpGPS_Settings::$_password);
+      phpGPS_Settings::$_dbname   = phpGPS_Settings::loadFromEnv("DB_NAME",     phpGPS_Settings::$_dbname);
+
+      phpGPS_Settings::$_devKey   = phpGPS_Settings::loadFromEnv("DEV_KEY", phpGPS_Settings::$_devKey);
+
+      phpGPS_Settings::$_secretKey = phpGPS_Settings::loadFromEnv("SECRET_KEY", phpGPS_Settings::$_secretKey);
+    }
+
+    private static function loadFromEnv($name, $default) {
+      if (isset($_ENV[$name])) {
+        return $_ENV[$name];
+      } else {
+        return $default;
+      }
+    }
   }
+
+  phpGPS_Settings::init();
 ?>

src/insertRecord.php

@@ -223,7 +223,7 @@ function saveMarkers() {
         var lat = newMarkers[i].getPosition().lat();
         var long = newMarkers[i].getPosition().lng();
         //TODO add passing in gps_date column, parsing from current date/time and adding editing for this field on edit marker page
-        var url = "insertRecord.php?insert=true&table=gps_entries&gps_latitude=" + lat + "&gps_longitude=" + long + "&gps_entry_date=now()&gps_name=" + newMarkers[i].name;
+        var url = "insertRecord.php?insert=true&table=gps_entries&gps_latitude=" + lat + "&gps_longitude=" + long + "&gps_entry_date=now()&gps_date=now()&gps_name=" + newMarkers[i].name;
         //prompt('', url);
         downloadUrl(url, function(data) {});
       }