Portainer Templates logo

Portainer Templates

ezBookkeeping ezBookkeeping

Stack

Finance

Personal finance app for logging what you spend and earn across accounts and currencies, with receipt photos, scheduled transactions and charts. Imports bank statement files, GnuCash and Firefly III, and installs on a phone like an app. Source: https://github.com/mayswind/ezbookkeeping

Source details

Repo: mayswind/ezbookkeeping
Stars: 6k
Forks: 709
Language: Go
License: MIT
Latest: v2.1.0 · 2 days ago
Updated: 2 days ago
Website: ezbookkeeping.mayswind.net/

Configuration

Type
Compose
Platform
linux
Env vars
EZBOOKKEEPING_SECRET_KEY=''EZBOOKKEEPING_DB_PASSWORD=''EZBOOKKEEPING_PORT=8100EZBOOKKEEPING_URL=http://localhost:8100/
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Set both secrets before you deploy (openssl rand -hex 32 makes good ones), since the stack won't start without them, and keep them the same when you redeploy. Put the address you'll actually type in the browser in the address field too, or receipt photos won't load. Then open http://<your-host>:8100 (or whichever port you picked) and create an account. Tick Use Preset Transaction Categories on the second step, or you start with none. Every account gets its own separate books, but sign-ups stay open, so once you've made yours add EZBOOKKEEPING_SIGNUPS = false to the stack's environment variables and update the stack. Exchange rates come from the European Central Bank, and maps load from OpenStreetMap. Everything lives in Postgres, in the postgres-data volume, with receipt photos and avatars in ezbookkeeping-storage. Docs: ezbookkeeping.mayswind.net

Services

ezbookkeeping

Configuration

Image
mayswind/ezbookkeeping:latest
Ports
${EZBOOKKEEPING_PORT:-8100}:8080
Volumes
/ezbookkeeping/storage : ezbookkeeping-storage
Env vars
EBK_SECURITY_SECRET_KEY=${EZBOOKKEEPING_SECRET_KEY:?Set a secret key}EBK_SERVER_ROOT_URL=${EZBOOKKEEPING_URL:-http://localhost:8100/}EBK_USER_ENABLE_REGISTER=${EZBOOKKEEPING_SIGNUPS:-true}EBK_DATABASE_TYPE=postgresEBK_DATABASE_HOST=postgres:5432EBK_DATABASE_NAME=ezbookkeepingEBK_DATABASE_USER=ezbookkeepingEBK_DATABASE_PASSWD=${EZBOOKKEEPING_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

Pulls: 920k
User: mayswind
Created: Apr 11, 2021
Updated: 2 days ago
Status: active

postgres

Configuration

Image
postgres:17-alpine
Volumes
/var/lib/postgresql/data : postgres-data
Env vars
POSTGRES_DB=ezbookkeepingPOSTGRES_USER=ezbookkeepingPOSTGRES_PASSWORD=${EZBOOKKEEPING_DB_PASSWORD:?Set a database password}
Restart
unless-stopped

Image details

Pulls: 11.9B
User: stackbrew
Created: Jun 05, 2014
Updated: 22 hours ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying ezBookkeeping

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 ezBookkeeping, 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 compose file this template deploys, straight from its repo:

services:
  ezbookkeeping:
    image: mayswind/ezbookkeeping:latest
    restart: unless-stopped
    ports:
      - "${EZBOOKKEEPING_PORT:-8100}:8080"
    environment:
      EBK_SECURITY_SECRET_KEY: ${EZBOOKKEEPING_SECRET_KEY:?Set a secret key}
      EBK_SERVER_ROOT_URL: ${EZBOOKKEEPING_URL:-http://localhost:8100/}
      EBK_USER_ENABLE_REGISTER: ${EZBOOKKEEPING_SIGNUPS:-true}
      EBK_DATABASE_TYPE: postgres
      EBK_DATABASE_HOST: postgres:5432
      EBK_DATABASE_NAME: ezbookkeeping
      EBK_DATABASE_USER: ezbookkeeping
      EBK_DATABASE_PASSWD: ${EZBOOKKEEPING_DB_PASSWORD:?Set a database password}
    volumes:
      - ezbookkeeping-storage:/ezbookkeeping/storage
    depends_on:
      postgres:
        condition: service_healthy

  postgres:
    image: postgres:17-alpine
    restart: unless-stopped
    environment:
      POSTGRES_DB: ezbookkeeping
      POSTGRES_USER: ezbookkeeping
      POSTGRES_PASSWORD: ${EZBOOKKEEPING_DB_PASSWORD:?Set a database password}
    volumes:
      - postgres-data:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U ezbookkeeping -d ezbookkeeping"]
      interval: 10s
      timeout: 5s
      retries: 5

volumes:
  ezbookkeeping-storage:
  postgres-data:

Or deploy it directly from the source:

git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/ezbookkeeping/compose.yml up -d

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

Container Documentation

ezbookkeeping Documentation

An open source, powerful, self-hosted personal finance app that is easy to use.

postgres Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

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.

Image won't pull

Test the pull directly on the host: docker pull mayswind/ezbookkeeping:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "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 Compose stack

ezBookkeeping is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

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:

  • ezbookkeeping runs mayswind/ezbookkeeping:latest, starts after postgres
  • postgres runs postgres:17-alpine

Volumes

A volume is where ezBookkeeping 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:

  • /ezbookkeeping/storage kept in the ezbookkeeping-storage volume Docker manages
  • /var/lib/postgresql/data kept in the postgres-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. ezBookkeeping takes 11 of them, and 3 need a value before it'll start properly:

  • EBK_SECURITY_SECRET_KEY, needs a value
  • EBK_SERVER_ROOT_URL, defaults to http://localhost:8100/
  • EBK_USER_ENABLE_REGISTER, defaults to true
  • EBK_DATABASE_TYPE, defaults to postgres
  • EBK_DATABASE_HOST, defaults to postgres:5432
  • EBK_DATABASE_NAME, defaults to ezbookkeeping
  • EBK_DATABASE_USER, defaults to ezbookkeeping
  • EBK_DATABASE_PASSWD, needs a value
  • POSTGRES_DB, defaults to ezbookkeeping
  • POSTGRES_USER, defaults to ezbookkeeping
  • POSTGRES_PASSWORD, needs a value

Restart policy

The restart policy here is unless-stopped, so Docker restarts ezBookkeeping 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 ezbookkeeping) 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

ezBookkeeping is open source, released under the MIT 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 ezBookkeeping up. Add the template list to Portainer once, then deploying ezBookkeeping is a click rather than a wall of config.