Merge pull request #187 from codedge/master

No logs for favicon and robots

.github/workflows/build_push.yml

@@ -31,11 +31,5 @@ jobs:
         - name: Push alpine-based image - v4
           run: make push-alpine TAG="${{steps.vars.outputs.tag}}"
 
-        - name: Build image from debian - v4
-          run: make build-debian TAG="${{steps.vars.outputs.tag}}"
-
-        - name: Push debian-based image - v4
-          run: make push-debian TAG="${{steps.vars.outputs.tag}}"
-
         - name: Logout from DockerHub
           run: docker logout

Makefile

@@ -11,6 +11,9 @@ IMAGE="invoiceninja"
 # Check if v5 tag is passed, so that a v5 version should be built
 IS_V5=$(shell echo ${TAG} | egrep ^5)
 
+# Version of Invoice Ninja. As the tag can be something like 5.0.4-p1, the version is 5.0.4.
+# This supports changes to the Dockerfiles with always the same Invoice Ninja version
+VERSION=$(shell echo ${TAG} | sed "s/-.*//")
 
 # Building docker images based on alpine.
 # Assigned tags:
@@ -19,10 +22,10 @@ IS_V5=$(shell echo ${TAG} | egrep ^5)
 .PHONY: build-alpine
 build-alpine:
 ifeq ($(IS_V5),)
-	$(info Make: Building "$(TAG)" tagged images from alpine.)
-	@docker build -t ${HUB_NAMESPACE}/${IMAGE}:alpine-${TAG} --build-arg INVOICENINJA_VERSION=${TAG} --file ./alpine/Dockerfile .
+	$(info Make: Building "$(VERSION)" tagged images from alpine.)
+	@docker build -t ${HUB_NAMESPACE}/${IMAGE}:alpine-${VERSION} --build-arg INVOICENINJA_VERSION=${VERSION} --file ./alpine/Dockerfile .
 	# Tag as alpine-4
-	@docker tag ${HUB_NAMESPACE}/${IMAGE}:alpine-${TAG} ${HUB_NAMESPACE}/${IMAGE}:alpine-4
+	@docker tag ${HUB_NAMESPACE}/${IMAGE}:alpine-${VERSION} ${HUB_NAMESPACE}/${IMAGE}:alpine-4
 	$(info Make: Done.)
 endif
 
@@ -30,7 +33,7 @@ endif
 push-alpine:
 ifeq ($(IS_V5),)
 	$(info Make: Pushing tagged images from alpine.)
-	@docker push ${HUB_NAMESPACE}/${IMAGE}:alpine-${TAG}
+	@docker push ${HUB_NAMESPACE}/${IMAGE}:alpine-${VERSION}
 	@docker push ${HUB_NAMESPACE}/${IMAGE}:alpine-4
 	$(info Make: Done.)
 endif
@@ -38,10 +41,10 @@ endif
 .PHONY: build-alpine-v5
 build-alpine-v5:
 ifneq ($(IS_V5),)
-	$(info Make: Building "$(TAG)" tagged images from alpine.)
-	@docker build -t ${HUB_NAMESPACE}/${IMAGE}:${TAG} --build-arg INVOICENINJA_VERSION=${TAG} --file ./alpine/Dockerfile_v5 .
-	@docker tag ${HUB_NAMESPACE}/${IMAGE}:${TAG} ${HUB_NAMESPACE}/${IMAGE}:5
-	@docker tag ${HUB_NAMESPACE}/${IMAGE}:${TAG} ${HUB_NAMESPACE}/${IMAGE}:latest
+	$(info Make: Building "$(VERSION)" tagged images from alpine.)
+	@docker build -t ${HUB_NAMESPACE}/${IMAGE}:${VERSION} --build-arg INVOICENINJA_VERSION=${VERSION} --file ./alpine/Dockerfile_v5 .
+	@docker tag ${HUB_NAMESPACE}/${IMAGE}:${VERSION} ${HUB_NAMESPACE}/${IMAGE}:5
+	@docker tag ${HUB_NAMESPACE}/${IMAGE}:${VERSION} ${HUB_NAMESPACE}/${IMAGE}:latest
 	$(info Make: Done.)
 endif
 
@@ -49,28 +52,7 @@ endif
 push-alpine-v5:
 ifneq ($(IS_V5),)
 	$(info Make: Pushing tagged images from alpine.)
-	@docker push ${HUB_NAMESPACE}/${IMAGE}:${TAG}
+	@docker push ${HUB_NAMESPACE}/${IMAGE}:${VERSION}
 	@docker push ${HUB_NAMESPACE}/${IMAGE}:5
 	@docker push ${HUB_NAMESPACE}/${IMAGE}:latest
 endif
-
-# Building docker images based on debian.
-# Assigned tags:
-#   - :latest
-#   - :<RELEASE VERSION>
-.PHONY: build-debian
-build-debian:
-ifeq ($(IS_V5),)
-	$(info Make: Building "$(TAG)" tagged images from debian.)
-	@docker build -t ${HUB_NAMESPACE}/${IMAGE}:${TAG} --build-arg INVOICENINJA_VERSION=${TAG} --file ./debian/Dockerfile .
-	$(info Make: Done.)
-endif
-
-.PHONY: push-debian
-push-debian:
-ifeq ($(IS_V5),)
-	$(info Make: Pushing tagged images from debian.)
-	@docker push ${HUB_NAMESPACE}/${IMAGE}:${TAG}
-	@docker push ${HUB_NAMESPACE}/${IMAGE}:latest
-	$(info Make: Done.)
-endif

README.md

@@ -14,167 +14,7 @@ If you feel your question is directly related to a code change or you want to se
 :pencil: Adjustable to your needs via environment variable  
 
 
-## Prerequisites
+## Documentation
 
-### Generate an application key
+Please see our [wiki](https://github.com/invoiceninja/dockerfiles/wiki) for further guidance.
 
-Before starting Invoice Ninja via Docker make sure you generate a valid application key. If you are not sure what an application key is, please visit [this blog post](https://tighten.co/blog/app-key-and-you/).  
-
-To generate an application just run
-
-```shell
-docker run --rm -it invoiceninja/invoiceninja php artisan key:generate --show
-```
-
-This will generate an application key for you which you need later.
-
-### Create folders for data persistence
-
-To make your data persistent, you have to mount `public` and `storage` from your host to your containers.
-
-1. Create two folder on your host, e. g. `/var/invoiceninja/public` and `/var/invoiceninja/storage`
-2. Mount these folders into your container - see [usage](#usage)
-
-You can create these folders wherever you want on your host system.
-
-:warning: When using host mounted folder for persistence, make sure they are owned by the proper user and group. As we run Invoice Ninja without `root` , we use a separate user, the folders on the host system need to be owned by uid `1000` and a gid `1001`.  
-
-Run this on your host system
-
-```shell
-chown -R 1000:101 /var/invoiceninja/public /var/invoiceninja/storage
-```
-
-to apply the proper permission to the folders. This also applies to the `docker-compose` setup when using [bind-mounted host directories](https://github.com/invoiceninja/dockerfiles/blob/master/docker-compose.yml#L17).
-
-
-### PhantomJS key
-
-The PhantomJS key is set to `a-demo-key-with-low-quota-per-ip-address`. This demo key is limited to 100 requests per day.
-
-To set a different key feel free to add `-e PHANTOMJS_CLOUD_KEY='<INSERT YOUR PHANTOMJS KEY HERE>'` to thee docker command below.
-
-For further configuration and toubleshotting regarding PhantomJS and Invoice Ninja [see documentation here](https://docs.invoiceninja.com/configure.html?#phantomjs).
-
-
-## Usage
-
-To run it:
-
-```shell
-docker run -d \
-  -v /var/invoiceninja/public:/var/app/public \
-  -v /var/invoiceninja/storage:/var/app/storage \
-  -e APP_URL='http://ninja.dev' \
-  -e APP_KEY='<INSERT THE GENERATED APPLICATION KEY HERE>' \
-  -e DB_HOST='localhost' \
-  -e DB_DATABASE='ninja' \
-  -e DB_USERNAME='ninja' \
-  -e DB_PASSWORD='ninja' \
-  -p '9000:9000' \
-  invoiceninja/invoiceninja
-```
-A list of environment variables can be found [here](https://github.com/invoiceninja/invoiceninja/blob/master/.env.example).
-
-
-### With docker-compose
-
-Running Invoice Ninja with docker-compose gives you everything to quickly start. Before starting please make sure you configured your setup correctly. You can do so by opening the `docker-compose.yml` and may change the follwing items.
-
-**Port**
-
-_default: 80_  
-
-This is the port where your Invoice Ninja is reachable, when you type in `http://<your-domain.com>`. If it should be different than `80` make sure to call your installation `http://<your-domain.com>:<YOUR-PORT>`, e. g. `http://<your-domain.com>:8080`.
-
-```yml
-ports: 
-  - "8080:80" # To run it on port 8080
-```
-
-:warning: Make sure the port set is available and not occupied by another service on your host system.
-
-**URL and application key**
-
-_default: https://localhost_
-
-For generating a proper application key see [generate an application key](#generate-an-application-key). Change the value where your Invoice Ninja installation should be reachable.
-
-```yml
-environment: 
-  - APP_URL=http://localhost
-````
-
-**MYSQL root password**
-
-_default: ninjaAdm1nPassword_
-
-The mysql database server comes with two users: one for accessing the Invoice Ninja database and the `root` user. Please change the default password for `root` to something more special :wink:
-
-**Volumes and directories**
-
-_default: volumes_
-
-This is the place where your uploaded files are stored. Normally this is a so called _volume_ which can be reused by different docker containers. One might prefer to store the files directly on the host system - for this the config section is prepared with what is called _bind-mounted host directory_. Just adjust the paths and Invoice Ninja stores the user files on the host system.
-
-```yml
-volumes:
-  ...
-  # Configure your mounted directories, make sure the folder 'public' and 'storage'
-  # exist, before mounting them
-  #-  public:/var/www/app/public
-  #-  storage:/var/www/app/storage
-  # you may use a bind-mounted host directory instead, so that it is harder to accidentally remove the volume and lose all your data!
-  - ./docker/app/public:/var/www/app/public:rw,delegated
-  - ./docker/app/storage:/var/www/app/storage:rw,delegated
-```
-
-The sample above stores the files on the post at `./docker/app/public` and `./docker/app/storage`.
-
-:warning: If using bind-mounted host directories make sure they exists and have proper rights. See [here](#create-folders-for-data-persistence) for details.
-
-## Docker secrets
-
-:information_source: This feature is borrowed from [mariadb docker image](https://hub.docker.com/_/mariadb).
-
-As an alternative to passing sensitive information via environment variables, `_FILE` may be appended to the below listed environment variables, causing the initialization script to load the values for those variables from files present in the container. In particular, this can be used to load passwords from Docker secrets stored in _/run/secrets/<secret_name>_ files.
-
-Supported are these variables:  
-`APP_KEY`, `API_SECRET`, `CLOUDFLARE_API_KEY`, `DB_USERNAME`, `DB_PASSWORD`, `MAIL_USERNAME`, `MAIL_PASSWORD`, `MAILGUN_SECRET`, `S3_KEY`, `S3_SECRET`
-
-
-## Debugging your Docker setup
-
-Even when running your Invoice Ninja setup with Docker - errors can occur. Depending on where the error happens - the webserver, Invoice Ninja or the database - different log files can be responsible. 
-
-### Show logs without `docker-compose`
-
-If you are not running `docker-compose` you first need to find the container id for your php container with `docker ps`. Then you can run
-
-```shell
-docker logs -f <CONTAINER NAME>
-```
-
-This gives you a constant output of the log files for the php container.
-
-### Show logs with `docker-compose`
-
-If you are running the `docker-compose` setup you can output all logs, from all containers, with the following command
-
-```shell
-docker-compose logs -f
-```
-
-If you better want a physical log file in in your `storage/logs` folder, just add `-e LOG=single` to the [usage](#usage) command. 
-Or add an environment variable 
-
-```yml
-...
-environment:
-  LOG: single
-...
-```
-
-to your `docker-compose.yml`.
-
-This generated log file will only hold Invoice Ninja information.

alpine/Dockerfile_v5

@@ -43,6 +43,8 @@ RUN chmod +x /usr/local/bin/docker-entrypoint
 
 RUN set -eux; \
     apk add --no-cache \
+    nodejs \
+    npm \
     freetype-dev \
     gmp-dev \
     libjpeg-turbo-dev \
@@ -92,4 +94,4 @@ ENV APP_ENV production
 ENV LOG errorlog
 
 ENTRYPOINT ["docker-entrypoint"]
-CMD ["php-fpm"]
+CMD ["php-fpm"]

config/caddy/Caddyfile

@@ -2,6 +2,5 @@
     root * /var/www/app/public
     php_fastcgi app:9000
     encode zstd gzip
-    templates
     file_server browse
 }

config/nginx/in-vhost.conf

@@ -0,0 +1,25 @@
+server {
+    listen 80 default_server;
+    server_name in.localhost;
+
+    root /var/www/app/public/;
+    index index.php;
+
+    location / {
+        try_files $uri $uri/ /index.php?$query_string;
+    }
+
+    location = /favicon.ico { access_log off; log_not_found off; }
+    location = /robots.txt  { access_log off; log_not_found off; }
+
+    location ~ \.php$ {
+        fastcgi_split_path_info ^(.+\.php)(/.+)$;
+        fastcgi_pass app:9000;
+        fastcgi_index index.php;
+        include fastcgi_params;
+        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+        fastcgi_intercept_errors off;
+        fastcgi_buffer_size 16k;
+        fastcgi_buffers 4 16k;
+    }
+}

debian/Dockerfile

@@ -1,76 +0,0 @@
-ARG PHP_VERSION=7.2
-
-FROM php:${PHP_VERSION}-fpm-stretch
-
-LABEL maintainer="Samuel Laulhau <sam@lalop.co>, Holger Lösken <holger.loesken@codedge.de>"
-
-#####
-# SYSTEM REQUIREMENT
-#####
-ARG INVOICENINJA_VERSION
-COPY ./debian/entrypoint.sh /usr/local/bin/docker-entrypoint
-RUN chmod +x /usr/local/bin/docker-entrypoint
-
-ENV BUILD_DEPS \
-        zlib1g-dev \
-        git \
-        libgmp-dev \
-        unzip \
-        libfreetype6-dev \
-        libjpeg62-turbo-dev \
-        libpng-dev \
-        build-essential \
-        chrpath \
-        libssl-dev \
-        libxft-dev \
-        libfreetype6 \
-        libfontconfig1 \
-        libfontconfig1-dev
-
-RUN apt-get update \
-    && apt-get install -y --no-install-recommends $BUILD_DEPS \
-    && ln -s /usr/include/x86_64-linux-gnu/gmp.h /usr/local/include/ \
-    && docker-php-ext-configure gd --with-freetype-dir=/usr/include/ --with-jpeg-dir=/usr/include/ \
-    && docker-php-ext-configure gmp \
-    && docker-php-ext-install iconv mbstring pdo pdo_mysql zip gd gmp opcache
-
-ENV PHANTOMJS phantomjs-2.1.1-linux-x86_64
-# Install PHANTOMJS
-RUN curl -o ${PHANTOMJS}.tar.bz2 -SL https://bitbucket.org/ariya/phantomjs/downloads/${PHANTOMJS}.tar.bz2 \
-    && tar xvjf ${PHANTOMJS}.tar.bz2 \
-    && rm ${PHANTOMJS}.tar.bz2 \
-    && mv ${PHANTOMJS} /usr/local/share \
-    && ln -sf /usr/local/share/${PHANTOMJS}/bin/phantomjs /usr/local/bin \
-    && rm -rf /var/lib/apt/lists/*
-
-COPY ./config/php/php.ini /usr/local/etc/php/php.ini
-COPY ./config/php/php-cli.ini /usr/local/etc/php/php-cli.ini
-
-# Download and install IN
-ENV INVOICENINJA_VERSION="${INVOICENINJA_VERSION}"
-
-RUN curl -o ninja.zip -SL https://download.invoiceninja.com/ninja-v${INVOICENINJA_VERSION}.zip \
-    && unzip -q ninja.zip -d /var/www/ \
-    && rm ninja.zip \
-    && mv /var/www/ninja /var/www/app  \
-    && mv /var/www/app/storage /var/www/app/docker-backup-storage  \
-    && mv /var/www/app/public /var/www/app/docker-backup-public  \
-    && mkdir -p /var/www/app/public/logo /var/www/app/storage \
-    && cp /var/www/app/.env.example /var/www/app/.env \
-    && chmod -R 755 /var/www/app/storage  \
-    && chown -R www-data:www-data /var/www/app/storage /var/www/app/bootstrap /var/www/app/public/logo /var/www/app/.env /var/www/app/docker-backup-storage /var/www/app/docker-backup-public\
-    && rm -rf /var/www/app/docs /var/www/app/tests /var/www/ninja
-
-# Override the environment settings from projects .env file
-ENV LOG errorlog
-ENV SELF_UPDATER_SOURCE ''
-ENV PHANTOMJS_BIN_PATH /usr/local/bin/phantomjs
-
-
-# use to be mounted into nginx for example
-VOLUME /var/www/app/public
-
-WORKDIR /var/www/app
-
-ENTRYPOINT ["docker-entrypoint"]
-CMD ["php-fpm"]

debian/entrypoint.sh

@@ -1,46 +0,0 @@
-#!/bin/bash
-set -e
-
-if [ ! -d /var/www/app/storage ]; then
-	cp -Rp /var/www/app/docker-backup-storage /var/www/app/storage
-else
-	IN_STORAGE_BACKUP="$(ls /var/www/app/docker-backup-storage/)"
-	for path in $IN_STORAGE_BACKUP; do
-		if [ ! -e "/var/www/app/storage/$path" ]; then
-			cp -Rp "/var/www/app/docker-backup-storage/$path" "/var/www/app/storage/"
-		fi
-	done
-fi
-
-if [ ! -d /var/www/app/public/logo ]; then
-	cp -Rp /var/www/app/docker-backup-public/logo /var/www/app/public/logo
-else
-	IN_LOGO_BACKUP="$(ls /var/www/app/docker-backup-public/logo/)"
-	for path in $IN_LOGO_BACKUP; do
-		if [ ! -e "/var/www/app/public/logo/$path" ]; then
-			cp -Rp "/var/www/app/docker-backup-public/logo/$path" "/var/www/app/public/logo/"
-		fi
-	done
-fi
-
-# compare public volume version with image version
-if [ ! -e /var/www/app/public/version ] || [ "$INVOICENINJA_VERSION" != "$(cat /var/www/app/public/version)" ]; then
-  echo 'clone public directory'
-  cp -Rp /var/www/app/docker-backup-public/* /var/www/app/public/
-  echo $INVOICENINJA_VERSION > /var/www/app/public/version
-fi
-
-# fix permission for mounted directories
-chown www-data:www-data /var/www/app/storage
-chown	 www-data:www-data /var/www/app/public/logo
-
-#php artisan optimize --force
-#php artisan migrate --force
-
-#if [ ! -e "/var/www/app/is-seeded" ]; then
-	#php artisan db:seed --force
-	#touch "/var/www/app/is-seeded"
-#fi
-
-echo 'start'
-exec "$@"

entrypoint.sh

@@ -12,16 +12,9 @@ in_error() {
         exit 1
 }
 
-# Indirect expansion (ie) is not supported in bourne shell. That's why we are using this clunkiness here.
+# Indirect expansion (ie) is not supported in bourne shell. That's why we are using this "magic" here.
 ie_gv() {
-        local line name value
-        set | \
-        while read line; do
-                name=${line%=*} value=${line#*=\'}
-                if [ "$name" = "$1" ]; then
-                        echo ${value%\'}
-                fi
-        done
+        eval "echo \$$1"
 }
 
 # usage: file_env VAR [DEFAULT]
@@ -37,7 +30,7 @@ file_env() {
                 in_error "Both $var and $fileVar are set (but are exclusive)"
         fi
 
-         local val="$def"
+        local val="$def"
         if [ "$(ie_gv ${var})" != "" ]; then
                 val=$(ie_gv ${var})
         elif [ "$(ie_gv ${fileVar})" != "" ]; then
@@ -88,9 +81,8 @@ if [ ! -e /var/www/app/public/version ] || [ "$INVOICENINJA_VERSION" != "$(cat /
     echo $INVOICENINJA_VERSION > /var/www/app/public/version
 fi
 
-# Set permission for mounted directories
-chown invoiceninja:www-data /var/www/app/storage
-chown invoiceninja:www-data /var/www/app/public
+# Set permission for web server to create/update files
+chown -R invoiceninja:www-data /var/www/app/storage /var/www/app/public /var/www/app/bootstrap
 
 # Initialize values that might be stored in a file
 file_env 'APP_KEY'
@@ -105,6 +97,7 @@ file_env 'S3_KEY'
 file_env 'S3_SECRET'
 
 # Run Laravel stuff
+php artisan config:cache
 php artisan optimize
 
 exec docker-php-entrypoint "$@"