feat: dockerize php application

.gitignore

@@ -1,4 +1,3 @@
 .idea
 .DS_Store
-.env
-configuration.env
+*.env

README.md

@@ -8,19 +8,15 @@ It uses a PHP Script for fetching data from the Spotify API and saves it to Infl
 
 It is advised to use a PHP website serving tool of your choice, such as [Laravel Valet].
 
-1. Copy ``configuration.env.dist`` to ``configuration.env`` and change the credentials
-1. Copy ``php/.env.dist`` to ``php/env`` and change the credentials
-2. Run ``docker-compose up -d`` to provision Grafana and InfluxDB
+1. Copy ``config/*.env.dist`` to ``config/*.env`` and change the credentials
+2. Run ``docker-compose up -d`` to provision Grafana, InfluxDB and PHP (via Nginx)
 3. Log in to the [Spotify Developer] website
-4. Set up a new Spotify App, save client id and client secret on your local machine
-5. Set up static website serving by using ``cd php && valet link spotisights``
-6. (optional) Make your connection secure by executing ``valet secure``
-7. Edit your Spotify App and add the callback URL ``https://spotisights.test/callback.php`` (http when not securing the connection)
+4. Set up a new Spotify App, add the callback URL ``http://localhost:8080/callback.php`` and add client id and client secret to ``php.env``
 
 ## Data Flow
 
-1. Call https://spotisights.test/ and follow the displayed auth flow (technical reference: [Authorization Code Flow])
-2. app.php will be called which collects recent tracks fron the logged in user, saves them to InfluxDB and prompts "done" when finished
+1. Call http://localhost:8080/ and follow the displayed auth flow (technical reference: [Authorization Code Flow])
+2. app.php is called and collects recent tracks fron the authorized user, saves them to InfluxDB and prompts "done" when finished
 3. Open Grafana at http://localhost:3000/ and navigate to the Dashboard "spotisights" (http://localhost:3000/?orgId=1&search=open)
 
 ## Auth

configuration.env.dist → config/grafana.env.dist

@@ -2,8 +2,3 @@
 GF_SECURITY_ADMIN_USER=admin
 GF_SECURITY_ADMIN_PASSWORD=admin
 GF_INSTALL_PLUGINS=
-
-# InfluxDB options
-INFLUXDB_DB=influx
-INFLUXDB_ADMIN_USER=admin
-INFLUXDB_ADMIN_PASSWORD=admin

config/influxdb.env.dist

@@ -0,0 +1,4 @@
+# InfluxDB options
+INFLUXDB_DB=influx
+INFLUXDB_ADMIN_USER=admin
+INFLUXDB_ADMIN_PASSWORD=admin

config/php.env.dist

@@ -0,0 +1,13 @@
+# InfluxDB
+INFLUXDB_URL=http://influxdb:8086
+INFLUXDB_TOKEN=secrettoken
+INFLUXDB_BUCKET=influx
+INFLUXDB_ORG=my-org
+
+# Spotify
+SPOTIFY_CLIENT_ID=123
+SPOTIFY_CLIENT_SECRET=123
+SPOTIFY_REDIRECT_URL=http://localhost:8080/callback.php
+
+# MISC
+USERNAME=testuser

docker-compose.yml

@@ -3,7 +3,7 @@ services:
 
   influxdb:
     image: influxdb:1.8-alpine
-    env_file: configuration.env
+    env_file: config/influxdb.env
     ports:
       - '8086:8086'
     volumes:
@@ -13,7 +13,7 @@ services:
     image: grafana/grafana:latest
     depends_on:
       - influxdb
-    env_file: configuration.env
+    env_file: config/grafana.env
     links:
       - influxdb
     ports:
@@ -23,6 +23,30 @@ services:
       - ./grafana/provisioning/:/etc/grafana/provisioning/
       - ./grafana/dashboards/:/var/lib/grafana/dashboards/
 
+  php:
+    build:
+      context: ./php
+    depends_on:
+      - influxdb
+    links:
+      - influxdb
+    env_file: config/php.env
+    ports:
+      - '8080:80'
+#      - '8443:443'
+    volumes:
+      - ./php/src:/app:rw,cached
+    environment:
+      - WEB_DOCUMENT_ROOT=/app/public
+      - PHP_DISPLAY_ERRORS=1
+      - PHP_MEMORY_LIMIT=2048M
+#      - PHP_MAX_EXECUTION_TIME=-1
+#      - XDEBUG_MODE=debug
+#      - XDEBUG_START_WITH_REQUEST=yes
+#      - XDEBUG_CLIENT_PORT=9000
+#      - XDEBUG_CLIENT_HOST=docker.local
+#      - XDEBUG_MAX_NESTING_LEVEL=1000
+
 volumes:
   grafana_data: { }
   influxdb_data: { }

php/Dockerfile

@@ -0,0 +1,13 @@
+FROM webdevops/php-nginx-dev:8.0
+
+RUN mkdir /app/sessions
+
+COPY ./src/composer.json /app/composer.json
+COPY ./src/composer.lock /app/composer.lock
+
+RUN composer install -d /app
+
+COPY ./src/app /app/app
+COPY ./src/public /app/public
+
+WORKDIR /app

php/nginx/default.conf

@@ -0,0 +1,16 @@
+server {
+    index index.php index.html;
+    server_name phpfpm.local;
+    error_log  /var/log/nginx/error.log;
+    access_log /var/log/nginx/access.log;
+    root /app/public;
+    location ~ \.php$ {
+        try_files $uri =404;
+        fastcgi_split_path_info ^(.+\.php)(/.+)$;
+        fastcgi_pass 127.0.0.1:9000;
+        fastcgi_index index.php;
+        include fastcgi_params;
+        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+        fastcgi_param PATH_INFO $fastcgi_path_info;
+    }
+}

php/.gitignore → php/src/.gitignore

@@ -1,3 +1,2 @@
-.env
 vendor/
 sessions

php/App/SessionHandler.php → php/src/app/SessionHandler.php

@@ -6,14 +6,14 @@
 
 class SessionHandler
 {
-    const BASE_FILEPATH = 'sessions';
+    const BASE_FILEPATH = '..' . DIRECTORY_SEPARATOR . 'sessions';
 
     public static function getSession(): Session
     {
         return new Session(
-            $_ENV['SPOTIFY_CLIENT_ID'],
-            $_ENV['SPOTIFY_CLIENT_SECRET'],
-            $_ENV['SPOTIFY_REDIRECT_URL'],
+            getenv('SPOTIFY_CLIENT_ID'),
+            getenv('SPOTIFY_CLIENT_SECRET'),
+            getenv('SPOTIFY_REDIRECT_URL'),
         );
     }
 

php/src/composer.json

@@ -0,0 +1,21 @@
+{
+    "name": "mashb1t/spotisights",
+    "description": "Spotify Insights",
+    "autoload": {
+        "psr-4": {
+            "App\\": "app"
+        }
+    },
+    "authors": [
+        {
+            "name": "Manuel Schmid",
+            "email": "[email protected]"
+        }
+    ],
+    "require": {
+        "league/statsd": "^1.5",
+        "ext-pcntl": "*",
+        "influxdata/influxdb-client-php": "^2.5",
+        "jwilsson/spotify-web-api-php": "^5.0"
+    }
+}