Docker for Invoice Ninja

This image is based on php:7.2-fpm official version.

Prerequisites

Generate an application key

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.

To generate an application just run

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.

Create two folder on your host, e. g. /var/invoiceninja/public and /var/invoiceninja/storage
Mount these folders into your container - see usage

You can create these folders wherever you want on your host system.

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.

Usage

To run it:

docker run -d \
  -v /var/invoiceninja/public:/var/app/public \
  -v /var/invoiceninja/storage:/var/app/storage \
  -e APP_ENV='production' \
  -e APP_DEBUG=0 \
  -e APP_URL='http://ninja.dev' \
  -e APP_KEY='<INSERT THE GENERATED APPLICATION KEY HERE>' \
  -e APP_CIPHER='AES-256-CBC' \
  -e DB_TYPE='mysql' \
  -e DB_STRICT='false' \
  -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.

With docker-compose

A ready to use docker-compose configuration can be found at ./docker-compose.

Run cp .env.example .env and change the environment variables as needed. The file assumes that all your persistent data is mounted from /srv/invoiceninja/. Once started, the application should be accessible at http://localhost:8000.

Known issues

Phantomjs doesn't work on linux alpine https://github.com/ariya/phantomjs/issues/14186.

2.5 KiB Raw Blame History