Portainer Templates logo

Portainer Templates

Invoice Ninja (swarm) Invoice Ninja (swarm)

CloudProductivityToolsOtherWeb

Invoices, Expenses and Tasks built with Laravel and Flutter.

Source details

Repo: invoiceninja/dockerfiles
Stars: 612
Forks: 346
Language: Go Template
License: GPL-2.0
Latest: 5.13.32 · 21 hours ago
Updated: 21 hours ago
Website: hub.docker.com/r/invoiceninja/invoiceninja-debian

Configuration

Type
Swarm
Platform
linux
Env vars
URL=invoice.my.domainAPP_KEY=''TZ=''DATABASE_PASSWORD=''MYSQL_ROOT_PASSWORD=''PORT=''
Source
Repo

Template by mikestraney·Source

Notes

The database user is invoice_ninja and the database is ninja_db. Please generate an app key following the documentation here.

Services

invoice-ninja

Configuration

Image
invoiceninja/invoiceninja:alpine-4
Ports
${PORT}:9000
Volumes
/var/app/public : /portainer/Files/AppData/Config/Invoice-Ninja/public/var/app/storage : /portainer/Files/AppData/Config/Invoice-Ninja/storage
Env vars
APP_URL=${URL}APP_KEY=${APP_KEY}MULTI_DB_ENABLED=falseDB_TYPE=mysqlDB_HOST1=ninja_dbDB_DATABASE=ninja_dbDB_USERNAME=invoice_ninjaDB_PASSWORD=${DATABASE_PASSWORD}
Restart
unless-stopped

Image details

Pulls: 32.5M
User: invoiceninja
Created: Mar 22, 2016
Updated: 20 hours ago
Status: active

ninja_db

Configuration

Image
linuxserver/mariadb
Volumes
/config : /portainer/Files/AppData/Config/Invoice-Ninja/DB
Env vars
MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}TZ=${TZ}MYSQL_DATABASE=ninja_dbMYSQL_USER=invoice_ninjaMYSQL_PASSWORD=${DATABASE_PASSWORD}
Restart
unless-stopped

Image details

Pulls: 417.9M
User: linuxserver
Created: Oct 13, 2015
Updated: 11 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Invoice Ninja (swarm)

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Invoice Ninja (swarm), fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The swarm stack file this template deploys, straight from its repo:

---
version: "3.6"
services:
  invoice-ninja:
    image: invoiceninja/invoiceninja:alpine-4
    container_name: invoice-ninja
    environment:
      - APP_URL=${URL}
      - APP_KEY=${APP_KEY}
      - MULTI_DB_ENABLED=false
      - DB_TYPE=mysql
      - DB_HOST1=ninja_db
      - DB_DATABASE=ninja_db
      - DB_USERNAME=invoice_ninja
      - DB_PASSWORD=${DATABASE_PASSWORD}
    volumes:
      - /portainer/Files/AppData/Config/Invoice-Ninja/public:/var/app/public
      - /portainer/Files/AppData/Config/Invoice-Ninja/storage:/var/app/storage
    ports:
      - ${PORT}:9000
    restart: unless-stopped
    depends_on:
      - ninja_db
  ninja_db:
    image: linuxserver/mariadb
    container_name: ninja_db
    environment:
      - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD}
      - TZ=${TZ}
      - MYSQL_DATABASE=ninja_db
      - MYSQL_USER=invoice_ninja
      - MYSQL_PASSWORD=${DATABASE_PASSWORD}
    volumes:
      - /portainer/Files/AppData/Config/Invoice-Ninja/DB:/config
    restart: unless-stopped

Or deploy it directly from the source:

git clone https://github.com/mikestraney/portainer-templates
cd portainer-templates
docker stack deploy -c stacks/invoice-ninja/docker-stack.yml invoice-ninja-swarm

More install options in our documentation, or see invoiceninja/dockerfiles for app-specific guidance.

Container Documentation

invoice-ninja Documentation

Invoices, Expenses and Tasks built with Laravel, Flutter and React

ninja_db Documentation

A Mariadb container, brought to you by LinuxServer.io.

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/Invoice-Ninja/public (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull invoiceninja/invoiceninja:alpine-4

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Swarm stack

Invoice Ninja (swarm) is a Swarm stack. Swarm is Docker's own way of running apps across more than one machine, so Portainer can spread it over a cluster and move it elsewhere if a server drops out.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • invoice-ninja runs invoiceninja/invoiceninja:alpine-4, starts after ninja_db
  • ninja_db runs linuxserver/mariadb

Volumes

A volume is where Invoice Ninja (swarm) keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/app/public from /portainer/Files/AppData/Config/Invoice-Ninja/public on the host
  • /var/app/storage from /portainer/Files/AppData/Config/Invoice-Ninja/storage on the host
  • /config from /portainer/Files/AppData/Config/Invoice-Ninja/DB on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Invoice Ninja (swarm) takes 13 of them, all with defaults you can leave alone or tweak:

  • APP_URL, pulled from your own environment
  • APP_KEY, pulled from your own environment
  • MULTI_DB_ENABLED, defaults to false
  • DB_TYPE, defaults to mysql
  • DB_HOST1, defaults to ninja_db
  • DB_DATABASE, defaults to ninja_db
  • DB_USERNAME, defaults to invoice_ninja
  • DB_PASSWORD, pulled from your own environment
  • MYSQL_ROOT_PASSWORD, pulled from your own environment
  • TZ, pulled from your own environment
  • MYSQL_DATABASE, defaults to ninja_db
  • MYSQL_USER, defaults to invoice_ninja
  • MYSQL_PASSWORD, pulled from your own environment

Restart policy

The restart policy here is unless-stopped, so Docker restarts Invoice Ninja (swarm) after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like invoice-ninja) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

Invoice Ninja (swarm) is open source, released under the GPL-2.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Invoice Ninja (swarm) up. Add the template list to Portainer once, then deploying Invoice Ninja (swarm) is a click rather than a wall of config.