How to Install Budget Board on Your Synology NAS

How to Install Budget Board on Your Synology NAS

Budget Board is an open-source web app for personal finance management. It simplifies monthly budgeting, expense tracking, and net worth monitoring with an intuitive interface and clear data visualizations. This privacy-focused tool is perfect for users seeking a customizable, cost-free solution to manage their finances effectively. In this step by step guide I will show you how to install Budget BoardĀ on your Synology NAS using Docker & Portainer.

šŸ’”Note:Ā This guide works perfectly with the latest Budget Board v2.1.6Ā release.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

InstallĀ Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

  • STEP 3

Go toĀ File StationĀ and open the docker folder. Inside the docker folder, create one new folder and name itĀ budgetboard-db. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Budget Board Synology NAS Set up 1

  • STEP 4

Log into Portainer using your username and password. On the left sidebar in Portainer, click on StacksĀ thenĀ + Add stack. Follow the instructions in the image below.

1 Synology Portainer Add Stack

  • STEP 5

In the Name field type in budgetboard. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

services:
  budget-board-server:
    container_name: Budget-Board-SERVER
    image: ghcr.io/teelur/budget-board/server:release
    environment:
      Logging__LogLevel__Default: Information
      CLIENT_URL: budget-board-client
      POSTGRES_HOST: budgetboard-db
      POSTGRES_DATABASE: budgetboard
      POSTGRES_USER: budgetboarduser
      POSTGRES_PASSWORD: budgetboardpass
      AUTO_UPDATE_DB: true
    depends_on:
      - db
    restart: on-failure:5
      
  budget-board-client:
    container_name: Budget-Board-CLIENT
    image: ghcr.io/teelur/budget-board/client:release
    environment:
      VITE_API_URL: budget-board-client
      PORT: 6253
    ports:
      - 6253:6253
    depends_on:
      - db
    restart: on-failure:5
      
  db:
    image: postgres:17
    container_name: Budget-Board-DB
    hostname: budgetboard-db
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "budgetboard", "-U", "budgetboarduser"]
      timeout: 45s
      interval: 10s
      retries: 10
    volumes:
      - /volume1/docker/budgetboard-db:/var/lib/postgresql/data:rw
    environment:
      POSTGRES_DB: budgetboard
      POSTGRES_USER: budgetboarduser
      POSTGRES_PASSWORD: budgetboardpass
    restart: on-failure:5

Budget Board Synology NAS Set up 2

  • STEP 6

Scroll down on the page until you see a button namedĀ Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

Budget Board Synology NAS Set up 3

  • STEP 7

If everything goes right, you will see the following message at the top right of your screen: ā€œSuccess Stack successfully deployedā€œ.

Budget Board Synology NAS Set up 4

  • STEP 8

šŸŸ¢Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guidesĀ forget to support my work, or justĀ ignoreĀ STEP 1. Iā€™ve been very honest about this aspect of my work since the beginning: I donā€™t run any ADS, I donā€™t require subscriptions, paid or otherwise, I donā€™t collect IPs, emails, and I donā€™t have any referral links from Amazon or other merchants. I also donā€™t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. Itā€™s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

  • STEP 9

The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser andĀ type in http://Synology-ip-address:6253 Click Register here. Follow the instructions in the image below.

Budget Board Synology NAS Set up 5

  • STEP 10

Type in your own Email and Password. Click Register. Follow the instructions in the image below.

Budget Board Synology NAS Set up 6

  • STEP 11

Type in the Email and Password that you have previously added at STEP 10, then click Login. Follow the instructions in the image below.

Budget Board Synology NAS Set up 7

  • STEP 12

Your Budget Board dashboard at a glance!

Budget Board Synology NAS Set up 8

Enjoy Budget Board!

šŸ†˜TROUBLESHOOTING

Note: If you want to run the Budget Board container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make Budget Board work over https, itā€™s also mandatory to set up WebSocket.

If you encounter issues by using this container, make sure to check out the Common Docker issuesĀ article.

Note: Can I run Docker on my Synology NAS?Ā See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find outĀ how to update the Budget Board container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Saturday / April 19th, 2025 at 2:35 PM