Portainer Templates logo

Portainer Templates

OpenBudgeteer OpenBudgeteer

Stack

Finance

OpenBudgeteer is a budgeting app based on the Bucket Budgeting Principle and inspired by YNAB and Buckets.

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

openbudgeteer

Configuration

Image
axelander/openbudgeteer
Ports
8081:80
Env vars
Connection:Server=openbudgeteer-mysqlConnection:Port=3306Connection:Database=openbudgeteerConnection:User=openbudgeteerConnection:Password=openbudgeteerAppSettings:Culture=en-US

Image details

Pulls: 222k
User: axelander
Created: Jul 21, 2020
Updated: 8 months ago
Status: active

mysql

Configuration

Image
mysql
Volumes
/var/lib/mysql : /portainer/Files/AppData/Config/openbudgeteer/data
Env vars
MYSQL_ROOT_PASSWORD=myRootPassword

Image details

Pulls: 5.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 19 days ago
Status: active

phpmyadmin

Configuration

Image
phpmyadmin/phpmyadmin
Ports
8080:80

Image details

Pulls: 406.3M
User: phpmyadmin
Created: Dec 04, 2015
Updated: 10 months ago
Status: active

Standalone Install

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

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 OpenBudgeteer, 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:

networks:
  app-global:
    external: true
  mysql-internal:


services:
  openbudgeteer:
    image: axelander/openbudgeteer
    container_name: openbudgeteer
    ports:
      - 8081:80
    environment:
      - Connection:Server=openbudgeteer-mysql
      - Connection:Port=3306
      - Connection:Database=openbudgeteer
      - Connection:User=openbudgeteer
      - Connection:Password=openbudgeteer
      - AppSettings:Culture=en-US
    depends_on:
      - mysql
    networks:
      - app-global
      - mysql-internal

  mysql:
    image: mysql
    container_name: openbudgeteer-mysql
    environment:
      MYSQL_ROOT_PASSWORD: myRootPassword
    volumes:
      - /portainer/Files/AppData/Config/openbudgeteer/data:/var/lib/mysql
    networks:
      - mysql-internal

  phpmyadmin:
    image: phpmyadmin/phpmyadmin
    container_name: openbudgeteer-phpmyadmin
    links:
      - mysql:db
    ports:
      - 8080:80
    networks:
      - app-global
      - mysql-internal

volumes:
  data:

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/openbudgeteer.yml up -d

More install options in our documentation.

Container Documentation

openbudgeteer Documentation

OpenBudgeteer is a budgeting app based on the Bucket Budgeting Principle

mysql Documentation

MySQL is a widely used, open-source relational database management system (RDBMS).

phpmyadmin Documentation

A web interface for MySQL and MariaDB.

Serve OpenBudgeteer on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying openbudgeteer.example.com to http://openbudgeteer:80

Add this to your Caddyfile

openbudgeteer.example.com {
	reverse_proxy http://openbudgeteer:80
}

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.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8081 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8081
  • Stop the other service, or pick a different host port. In 8081:80 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8081. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, openbudgeteer can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8081

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/openbudgeteer/data

Image won't pull

Test the pull directly on the host: docker pull axelander/openbudgeteer

  • "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.

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

OpenBudgeteer is a Compose stack, a set of containers (3 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 3 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • openbudgeteer runs axelander/openbudgeteer, starts after mysql
  • mysql runs mysql
  • phpmyadmin runs phpmyadmin/phpmyadmin

Ports

A port is the door the app answers on. A mapping like 8081:80 means it's reachable on port 8081 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8081 in a browser. It opens:

  • 8081:80, likely the web interface
  • 8080:80, likely the web interface

Volumes

A volume is where OpenBudgeteer 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/lib/mysql from /portainer/Files/AppData/Config/openbudgeteer/data on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. OpenBudgeteer takes 7 of them, all with defaults you can leave alone or tweak:

  • Connection:Server, defaults to openbudgeteer-mysql
  • Connection:Port, defaults to 3306
  • Connection:Database, defaults to openbudgeteer
  • Connection:User, defaults to openbudgeteer
  • Connection:Password, defaults to openbudgeteer
  • AppSettings:Culture, defaults to en-US
  • MYSQL_ROOT_PASSWORD, defaults to myRootPassword

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like openbudgeteer) 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.

Portainer app templates

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