223 remove sqlite and docs overhaul (#232)

* Created a Makefile

* Makefile works with for loop

* Conditional check for tagging semver

* Added empty(ish) compose files

* Swited to makefile

* Hard coded env vars that don't work

* Added docker-compose

* Better docs

* Update README.md

* Fixed some docs

Author: tobybatch

Dockerfile

@@ -5,8 +5,8 @@
 # |_|\_\_|_| |_| |_|\__,_|_|_____|
 #
 
-# Source base [fpm-alpine/apache-debian]
-ARG BASE="fpm-alpine"
+# Source base [fpm/apache]
+ARG BASE="fpm"
 
 ###########################
 # Shared tools
@@ -16,7 +16,7 @@ ARG BASE="fpm-alpine"
 FROM alpine:3.13.5 AS git-dev
 ARG KIMAI="1.12"
 # I need to do this check somewhere, we discard all but the checkout so doing here doesn't hurt
-ADD test-kimai-version.sh /test-kimai-version.sh
+ADD assets/test-kimai-version.sh /test-kimai-version.sh
 RUN /test-kimai-version.sh
 RUN apk add --no-cache git && \
     git clone --depth 1 --branch ${KIMAI} https://github.com/kevinpapst/kimai2.git /opt/kimai
@@ -35,7 +35,7 @@ FROM composer:2.0.12 AS composer
 ###########################
 
 #fpm alpine php extension base
-FROM php:7.4.15-fpm-alpine3.13 AS fpm-alpine-php-ext-base
+FROM php:7.4.15-fpm-alpine3.13 AS fpm-php-ext-base
 RUN apk add --no-cache \
     # build-tools
     autoconf \
@@ -70,7 +70,7 @@ RUN apk add --no-cache \
 
 
 # apache debian php extension base
-FROM php:7.4.15-apache-buster AS apache-debian-php-ext-base
+FROM php:7.4.15-apache-buster AS apache-php-ext-base
 RUN apt-get update
 RUN apt-get install -y \
         libldap2-dev \
@@ -111,13 +111,14 @@ RUN docker-php-ext-install -j$(nproc) xsl
 
 
 ###########################
-# fpm-alpine base build
+# fpm base build
 ###########################
 
-# fpm-alpine base build
-FROM php:7.4.15-fpm-alpine3.13 AS fpm-alpine-base
+# fpm base build
+FROM php:7.4.15-fpm-alpine3.13 AS fpm-base
 RUN apk add --no-cache \
         bash \
+        coreutils \
         freetype \
         haveged \
         icu \
@@ -140,11 +141,11 @@ HEALTHCHECK --interval=20s --timeout=10s --retries=3 \
 
 
 ###########################
-# apache-debian base build
+# apache base build
 ###########################
 
-FROM php:7.4.15-apache-buster AS apache-debian-base
-COPY 000-default.conf /etc/apache2/sites-available/000-default.conf
+FROM php:7.4.15-apache-buster AS apache-base
+COPY assets/000-default.conf /etc/apache2/sites-available/000-default.conf
 RUN apt-get update && \
     apt-get install -y \
         bash \
@@ -183,8 +184,9 @@ RUN ln -snf /usr/share/zoneinfo/${TZ} /etc/localtime && echo ${TZ} > /etc/timezo
     chown -R www-data:www-data /composer
 
 # copy startup script & DB checking script
-COPY startup.sh /startup.sh
-COPY dbtest.php /dbtest.php
+COPY assets/startup.sh /startup.sh
+COPY assets/self-test.sh /self-test.sh
+COPY assets/dbtest.php /dbtest.php
 
 # copy composer
 COPY --from=composer /usr/bin/composer /usr/bin/composer
@@ -225,6 +227,8 @@ ENV DB_PASS=
 ENV DB_HOST=
 ENV DB_PORT=
 ENV DB_BASE=
+# If this set then the image will start, run a self test and then exit. It's used for the release process
+ENV TEST_AND_EXIT=
 
 
 VOLUME [ "/opt/kimai/var" ]
@@ -241,7 +245,7 @@ ENTRYPOINT /startup.sh
 FROM base AS dev
 # copy kimai develop source
 COPY --from=git-dev --chown=www-data:www-data /opt/kimai /opt/kimai
-COPY monolog-dev.yaml /opt/kimai/config/packages/dev/monolog.yaml
+COPY assets/monolog-dev.yaml /opt/kimai/config/packages/dev/monolog.yaml
 # do the composer deps installation
 RUN export COMPOSER_HOME=/composer && \
     composer --no-ansi install --working-dir=/opt/kimai --optimize-autoloader && \
@@ -253,13 +257,14 @@ RUN export COMPOSER_HOME=/composer && \
     sed "s/128M/-1/g" /usr/local/etc/php/php.ini-development > /opt/kimai/php-cli.ini && \
     sed -i "s/env php/env -S php -c \/opt\/kimai\/php-cli.ini/g" /opt/kimai/bin/console
 ENV APP_ENV=dev
+ENV DATABASE_URL=
 USER www-data
 
 # production build
 FROM base AS prod
 # copy kimai production source
 COPY --from=git-prod --chown=www-data:www-data /opt/kimai /opt/kimai
-COPY monolog-prod.yaml /opt/kimai/config/packages/prod/monolog.yaml
+COPY assets/monolog-prod.yaml /opt/kimai/config/packages/prod/monolog.yaml
 # do the composer deps installation
 RUN export COMPOSER_HOME=/composer && \
     composer --no-ansi install --working-dir=/opt/kimai --no-dev --optimize-autoloader && \
@@ -269,4 +274,5 @@ RUN export COMPOSER_HOME=/composer && \
     mkdir -p /opt/kimai/var/logs && chmod 777 /opt/kimai/var/logs && \
     chown -R www-data:www-data /opt/kimai
 ENV APP_ENV=prod
+ENV DATABASE_URL=
 USER www-data

Makefile

@@ -0,0 +1,63 @@
+include .env
+
+ifndef TIMEZONE
+  TIMEZONE := Europe/London
+endif
+
+ifndef KIMAI_VERSION
+  KIMAI_VERSION := master
+endif
+
+ZAP := $(shell echo $(KIMAI_VERSION) | egrep -q "[0-9].[0-9]+" && echo matched)
+
+build:
+	docker build -t kimai2/kimai:fpm-${KIMAI_VERSION}-dev --build-arg KIMAI=${KIMAI_VERSION} --build-arg BASE=fpm --build-arg TZ=${TIMEZONE} --target=dev .
+	docker build -t kimai2/kimai:fpm-${KIMAI_VERSION}-prod --build-arg KIMAI=${KIMAI_VERSION} --build-arg BASE=fpm --build-arg TZ=${TIMEZONE} --target=prod .
+	docker build -t kimai2/kimai:apache-${KIMAI_VERSION}-dev --build-arg KIMAI=${KIMAI_VERSION} --build-arg BASE=apache --build-arg TZ=${TIMEZONE} --target=dev .
+	docker build -t kimai2/kimai:apache-${KIMAI_VERSION}-prod --build-arg KIMAI=${KIMAI_VERSION} --build-arg BASE=apache --build-arg TZ=${TIMEZONE} --target=prod .
+
+tag:
+ifeq (${ZAP}, matched)
+	docker tag kimai2/kimai:fpm-${KIMAI_VERSION}-prod kimai2/kimai:fpm
+	docker tag kimai2/kimai:fpm-${KIMAI_VERSION}-dev kimai2/kimai:fpm-dev
+	docker tag kimai2/kimai:apache-${KIMAI_VERSION}-prod kimai2/kimai:apache
+	docker tag kimai2/kimai:apache-${KIMAI_VERSION}-dev kimai2/kimai:apache-dev
+	docker tag kimai2/kimai:fpm-${KIMAI_VERSION}-prod kimai2/kimai:latest
+	docker tag kimai2/kimai:apache-${KIMAI_VERSION}-dev kimai2/kimai:latest-dev
+else
+	$(error ${KIMAI_VERSION} does not look like a release, x.y or x.y.z. Not tagging)
+endif
+
+push:
+	docker push kimai2/kimai:fpm-${KIMAI_VERSION}-dev
+	docker push kimai2/kimai:fpm-${KIMAI_VERSION}-prod
+	docker push kimai2/kimai:apache-${KIMAI_VERSION}-dev
+	docker push kimai2/kimai:apache-${KIMAI_VERSION}-prod
+ifeq (${ZAP}, matched)
+	docker push kimai2/kimai:kimai2/kimai:fpm-latest-prod
+	docker push kimai2/kimai:kimai2/kimai:fpm-latest-dev
+	docker push kimai2/kimai:kimai2/kimai:apache-latest-prod
+	docker push kimai2/kimai:kimai2/kimai:apache-latest-dev
+	docker push kimai2/kimai:kimai2/kimai:latest
+	docker push kimai2/kimai:kimai2/kimai:latest-dev
+endif
+
+clean-test:
+	docker stop kimai-mysql-testing || true
+	docker stop kimai-test-fpm-${KIMAI_VERSION}-prod || true
+	docker stop kimai-test-fpm-${KIMAI_VERSION}-dev || true
+	docker stop kimai-test-apache-${KIMAI_VERSION}-prod || true
+	docker stop kimai-test-apache-${KIMAI_VERSION}-dev || true
+	docker network rm kimai-test || true
+
+test: clean-test
+	docker network create --driver bridge kimai-test
+	docker run --rm --network kimai-test --name kimai-mysql-testing -e MYSQL_DATABASE=kimai -e MYSQL_USER=kimai -e MYSQL_PASSWORD=kimai -e MYSQL_ROOT_PASSWORD=kimai -p 3399:3306 -d mysql
+	docker run --rm --network kimai-test --name kimai-test-fpm-${KIMAI_VERSION}-prod    -ti -e DATABASE_URL=mysql://kimai:kimai@kimai-mysql-testing:3306/kimai --entrypoint /self-test.sh kimai2/kimai:fpm-${KIMAI_VERSION}-prod
+	docker run --rm --network kimai-test --name kimai-test-fpm-${KIMAI_VERSION}-dev     -ti -e DATABASE_URL=mysql://kimai:kimai@kimai-mysql-testing:3306/kimai --entrypoint /self-test.sh kimai2/kimai:fpm-${KIMAI_VERSION}-dev
+	docker run --rm --network kimai-test --name kimai-test-apache-${KIMAI_VERSION}-prod -ti -e DATABASE_URL=mysql://kimai:kimai@kimai-mysql-testing:3306/kimai --entrypoint /self-test.sh kimai2/kimai:apache-${KIMAI_VERSION}-prod
+	docker run --rm --network kimai-test --name kimai-test-apache-${KIMAI_VERSION}-dev  -ti -e DATABASE_URL=mysql://kimai:kimai@kimai-mysql-testing:3306/kimai --entrypoint /self-test.sh kimai2/kimai:apache-${KIMAI_VERSION}-dev
+
+build-version: build test push
+
+release: build test tag push

README.md

@@ -6,20 +6,106 @@ The built images are available from [Kimai v2](https://hub.docker.com/repository
 
 ## Quick start
 
-Run the latest build against tbe master branch of the Kimai repo using a bundled DB. **This is not suitable for production use**:
+Run the latest production build:
 
-    docker run --rm -ti -p 8001:8001 --name kimai kimai/kimai2:latest-dev
+ 1. Start a DB
+ 
+        docker run --rm --name kimai-mysql-testing \
+            -e MYSQL_DATABASE=kimai \
+            -e MYSQL_USER=kimai \
+            -e MYSQL_PASSWORD=kimai \
+            -e MYSQL_ROOT_PASSWORD=kimai \
+            -p 3399:3306 -d mysql
+        
+ 1. Start Kimai 
+   
+        docker run --rm --name kimai-test \
+            -ti \
+            -p 8001:8001 \
+            -e DATABASE_URL=mysql://kimai:kimai@${HOSTNAME}:3399/kimai \
+            kimai2/kimai:apache-latest-prod
+ 
+ 1. Add a user, open a new terminal and:
+ 
+        docker exec -ti kimai-test \
+            /opt/kimai/bin/console kimai:create-user admin admin@example.com ROLE_SUPER_ADMIN
+    
+You can now hit the kimai instance on http://localhost:8001
 
-Create an admin user in the new running docker:
+This docker transient and will disappear when you stop the containers.
 
-    docker exec kimai /opt/kimai/bin/console kimai:create-user admin admin@example.com ROLE_SUPER_ADMIN
+    docker stop kimai-mysql-testing kimai-test
 
-This docker transient and will disappear when you stop the container.
+## Using docker-compose
 
-## Documentation
+This will run the latest prod version using FPM with an nginx reverse proxy
 
-[https://tobybatch.github.io/kimai2/](https://tobybatch.github.io/kimai2/)
+```docker-compose
+version: '3.5'
+services:
+
+  sqldb:
+    image: mysql:5.7
+    environment:
+      - MYSQL_DATABASE=kimai
+      - MYSQL_USER=kimaiuser
+      - MYSQL_PASSWORD=kimaipassword
+      - MYSQL_ROOT_PASSWORD=changemeplease
+    #volumes: # Uncomment to persist data
+      #- /var/lib/mysql
+    command: --default-storage-engine innodb
+    restart: unless-stopped
+    healthcheck:
+      test: mysqladmin -p$$MYSQL_ROOT_PASSWORD ping -h localhost
+      interval: 20s
+      start_period: 10s
+      timeout: 10s
+      retries: 3
+
+  nginx:
+    image: tobybatch/nginx-fpm-reverse-proxy
+    ports:
+      - 8001:80
+    volumes:
+      - public:/opt/kimai/public:ro
+    restart: unless-stopped
+    depends_on:
+      - kimai
+    healthcheck:
+      test:  wget --spider http://nginx/health || exit 1
+      interval: 20s
+      start_period: 10s
+      timeout: 10s
+      retries: 3
+
+  kimai: # This is the latest FPM image of kimai
+    image: kimai2/kimai:fpm-latest-prod
+    environment:
+      - APP_ENV=prod
+      - TRUSTED_HOSTS=localhost
+      - ADMINMAIL=admin@kimai.local
+      - ADMINPASS=changemeplease
+      - DATABASE_URL=mysql://kimaiuser:kimaipassword@sqldb/kimai
+      - TRUSTED_HOSTS=nginx,localhost,127.0.0.1
+    volumes:
+      - public:/opt/kimai/public
+      # - var:/opt/kimai/var
+      # - ./ldap.conf:/etc/openldap/ldap.conf:z
+      # - ./ROOT-CA.pem:/etc/ssl/certs/ROOT-CA.pem:z
+    restart: unless-stopped
 
-## Kimai Helm chart
+  postfix:
+    image: catatnight/postfix:latest
+    environment:
+      maildomain: neontribe.co.uk
+      smtp_user: kimai:kimai
+    restart: unless-stopped
 
-There is also a Helm chart for easy deployment of Kimai on Kubernetes. See the [README](docs/helm/README.md) for more information.
+volumes:
+    var:
+    public:
+```
+
+## Documentation
+
+[https://tobybatch.github.io/kimai2/](https://tobybatch.github.io/kimai2/)

ROOT-CA.pem

@@ -0,0 +1,59 @@
+#!/bin/sh
+
+nohup /startup.sh 2>&1 & > /tmp/startup.log
+echo $$ > /tmp/startup.pid
+echo "Waiting for kimai to install"
+while [ ! -f /opt/kimai/var/installed ]; do
+  echo -n ". "
+  sleep 5
+done
+echo
+
+# Test FPM CGI
+if [ -f /use_fpm ]; then
+
+  export SCRIPT_NAME=/opt/kimai/public/index.php
+  export SCRIPT_FILENAME=/opt/kimai/public/index.php
+  export REQUEST_METHOD=GET
+  export SERVER_ADDR=localhost
+
+  COUNT=0
+  until cgi-fcgi -bind -connect 127.0.0.1:9000 &> /dev/null
+  do
+    COUNT=$((COUNT+1))
+    echo "Waiting for FPM Server to start (${COUNT})"
+    sleep 3
+    if [ "$COUNT" -gt 5 ]; then
+      echo "FPM Failed to start."
+      exit 1
+    fi
+  done
+
+fi
+
+# Test Apache/httpd
+if [ -f /use_apache ]; then
+
+  COUNT=0
+  until curl -s -o /dev/null http://localhost:8001
+  do
+    COUNT=$((COUNT+1))
+    echo "Waiting for Apache/HTTP to start (${COUNT})" &> /dev/null
+    sleep 3
+    if [ "$COUNT" -gt 5 ]; then
+      echo "Apache/HTTP failed to start."
+      exit 1
+    fi
+  done
+
+fi
+
+# Test PHP/Kimai
+/opt/kimai/bin/console kimai:version
+if [ $? != 0 ]; then
+  echo "PHP/Kimai not responding"
+  exit 1
+fi
+kill $(cat /tmp/startup.pid)
+
+

000-default.conf renamed to assets/000-default.conf

@@ -44,7 +44,7 @@ function waitForDB() {
 
 function handleStartup() {
   # first start?
-  if ! [ -e /opt/kimai/installed ]; then 
+  if ! [ -e /opt/kimai/var/installed ]; then 
     echo "first run - install kimai"
     /opt/kimai/bin/console -n kimai:install
     if [ ! -z "$ADMINPASS" ] && [ ! -a "$ADMINMAIL" ]; then
@@ -53,7 +53,7 @@ function handleStartup() {
   fi
   # Add this here so it's always available, it would be lost between conatiner restarts.
   export KIMAI=$(/opt/kimai/bin/console kimai:version --short)
-  echo $KIMAI > /opt/kimai/installed
+  echo $KIMAI > /opt/kimai/var/installed
   echo "Kimai2 ready"
 }