Merge pull request #123 from Ente/TT-71-1

TT-71: Dockerized version

Author: Ente

.dockerignore

@@ -0,0 +1,9 @@
+.git
+.gitignore
+vendor
+node_modules
+Dockerfile
+docker-compose.yml
+*.md
+*.log
+tests

CHANGELOG.md

@@ -1,5 +1,13 @@
 # CHANGELOG
 
+## v8.2.2
+
+* Fixed deprecation warning for `WorktimeAddedEvent` event
+* Dockerized TimeTrack:
+  * Added `Dockerfile` and `docker-compose.yml` to run TimeTrack within Docker
+  * Added `entrypoint.sh` to handle database migrations and start Apache
+  * Updated `README.md` with Docker instructions
+
 ## v8.2.1
 
 * Added events for worktime correction proposals: `WorktimeCorrectionProposed`

README.md

@@ -19,6 +19,22 @@ TimeTrack aims to be an easy-to-use time recording software for small enterprise
 
 ## Installation
 
+### Quick Install with Docker
+
+You can quickly get started with TimeTrack using Docker. Follow these steps:
+
+* Ensure you have Docker and Docker Compose installed on your system.
+* Clone the TimeTrack repository: `git clone https://github.com/Ente/timetrack.git` & `cd timetrack`
+* Build the Docker image: `docker build -t openducks/timetrack .`
+* Create a `app.json` configuration file based on the provided sample below: `cp api/v1/inc/app.json.sample api/v1/inc/app.json` and edit it to fit your needs.
+  * Adjust the database settings if needed (at least `db_password`)
+  * Change the base_url to match your setup (e.g. `localhost:8080`)
+  * **Change the DB password before using in production within the `docker-compose.yml` and `app.json` file!**
+* Start the services using Docker Compose: `docker-compose up -d`
+* Access TimeTrack in your web browser at `http://localhost:8080`
+
+Certain features, like the NFC login may require additional setup for parsing the USB device.
+
 ### Requirements
 
 - PHP 8.2 (`curl|gd|gmp|intl|mbstring|mysqli|openssl|xsl|gettext|dom|ldap`) - tested with PHP 8.2.26

api/v1/class/events/worktimes/WorktimeAddedEvent.php

@@ -12,7 +12,7 @@ class WorktimeAddedEvent extends Event
 
     private string $Wtype;
 
-    public function __construct(string $username, array $dates = [], int $Wtype){
+    public function __construct(string $username, int $Wtype, array $dates = []){
         $this->username = $username;
         $this->dates = $dates;
         $this->Wtype = $Wtype;

api/v1/class/projects/projects.arbeit.inc.php

@@ -9,7 +9,7 @@ public function __construct()
             $this->db = new DB;
         }
 
-        public function addProject($name, $description = null, $items_assoc, $deadline = null, $owner = null)
+        public function addProject($name, $items_assoc, $description = null, $deadline = null, $owner = null)
         {
             Exceptions::error_rep("[PROJECTS] Adding project...");
             if ($items_assoc == null) {

api/v1/inc/app.json.sample

@@ -11,9 +11,9 @@
         "force_theme": "false"
     },
     "mysql": {
-        "db_host": "localhost",
-        "db_user": "root",
-        "db_password": "",
+        "db_host": "db",
+        "db_user": "timetool",
+        "db_password": "yourpassword",
         "db": "ab"
     },
     "smtp": {

docker/apache2.conf

@@ -0,0 +1,11 @@
+<VirtualHost *:80>
+    DocumentRoot /var/www/html
+    <Directory /var/www/html>
+        Options Indexes FollowSymLinks
+        AllowOverride All
+        Require all granted
+    </Directory>
+
+    ErrorLog ${APACHE_LOG_DIR}/error.log
+    CustomLog ${APACHE_LOG_DIR}/access.log combined
+</VirtualHost>

docker/entrypoint.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+set -e
+
+# Waiting for the database to be ready
+echo "Waiting for database to be ready..."
+sleep 10
+
+# Run Phinx migrations
+echo "Running database migrations..."
+if [ -f /var/www/html/vendor/bin/phinx ]; then
+  php /var/www/html/vendor/bin/phinx migrate || true
+else
+  echo "Phinx not found — skipping migration."
+fi
+
+# Start PC/SC daemon for smartcard/NFC
+echo "Starting pcscd..."
+pcscd --daemon &
+
+
+# Start Apache
+echo "Starting Apache..."
+exec apache2-foreground