How to Install BudgetBee on Your Synology NAS

How to Install BudgetBee on Your Synology NAS

BudgetBee is a personal budget system. With BudgetBee you can easily manage your personal finances. It can help you keep track of your expenses and income so you can spend less and save more. In this step by step guide I will show you how to install BudgetBee on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest BudgetBee v0.7.2 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

Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.

  • STEP 4

Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.

BudgetBee Synology NAS Set up 1

 

  • STEP 5

Now click the “Create” button. Follow the instructions in the image below.

BudgetBee Synology NAS Set up 2

  • STEP 6

After you click the Create button, the window below will open. Follow the instructions in the image below.

On the General area, set the Reverse Proxy Name description: type in BudgetBee. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: budgetbee.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 8201

BudgetBee Synology NAS Set up 3

  • STEP 7

On the Reverse Proxy Rules click the Custom Header tab. Click Create and then, from the drop-down menu, click WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.

Synology Proxy WebSocket

  • STEP 8

Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

BudgetBee Synology NAS Set up 4

  • STEP 9

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.

BudgetBee Synology NAS Set up 5

  • STEP 10

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

BudgetBee Synology NAS Set up 6

  • STEP 11

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 12

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

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

version: "3.9"
services:
  db:
    image: mariadb:11.3
    container_name: BudgetBee-DB
    hostname: budgetbee-db
    mem_limit: 1g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    volumes:
      - /volume1/docker/budgetbee:/var/lib/mysql:rw
    environment:
      TZ: Europe/Bucharest
      MARIADB_RANDOM_ROOT_PASSWORD: true
      MARIADB_DATABASE: budgetbee
      MARIADB_USER: budgetbeeuser
      MARIADB_PASSWORD: budgetbeepass
    restart: on-failure:5

  backend:
    image: ghcr.io/budgetbee/budgetbee/api:latest
    command: sh entrypoint.sh
    container_name: BudgetBee-API
    hostname: webserver
    mem_limit: 1g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    working_dir: /var/www/html
    environment:
      DB_HOST: budgetbee-db
      DB_DATABASE: budgetbee
      DB_USERNAME: budgetbeeuser
      DB_PASSWORD: budgetbeepass
    restart: on-failure:5
    depends_on:
      db:
        condition: service_started

  web:
    image: ghcr.io/budgetbee/budgetbee/web:latest
    container_name: BudgetBee-FRONT
    hostname: web
    mem_limit: 2g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    restart: on-failure:5

  nginx:
    image: ghcr.io/budgetbee/budgetbee/proxy:latest
    command: nginx -g "daemon off;"
    container_name: BudgetBee-NGINX
    hostname: nginx
    mem_limit: 512m
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: wget --no-verbose --tries=1 --spider http://localhost
    ports:
      - 8201:80
    restart: on-failure:5
    depends_on:
      - backend

Note: Before you paste the code in the Portainer Web editor area, change the value numbers for user with your own values. (Follow my step by step guide on how to do this.1026 is my personal UID value and 100 is my personal GID value. You have to type in your own values.
Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.) Europe/Bucharest is my own Time Zone value. You have to type in your own Time Zone.

BudgetBee-Synology-NAS-Set-up-7-new-2025

  • STEP 13

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.

BudgetBee Synology NAS Set up 8

  • STEP 14

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

BudgetBee Synology NAS Set up 9

  • STEP 15

Create your admin user. On the left sidebar in Portainer, click Containers. Identify your BudgetBee-API instance, then click on the little terminal icon. Follow the instructions in the image below.

BudgetBee Synology NAS Set up 10

  • STEP 16

After you click on the little terminal icon at STEP 15, a new page will open. From the drop-down Command menu select /bin/ash then click Connect. Follow the instructions in the image below.

BudgetBee Synology NAS Set up 11

  • STEP 17

After you click Connect at STEP 16, a Console will open. Copy paste the code below and confirm by pressing Enter on your keyboard to start the admin rights process. Follow the instructions in the image below.

 php artisan migrate --force

BudgetBee Synology NAS Set up 12 new 2023

  • STEP 18

After the migration table is complete, copy paste the code below and confirm by pressing Enter on your keyboard to start the admin rights process. Follow the instructions in the image below. mariushosting is an example for a password you should use your own password.

php scripts/create_user.php admin yourownemail mariushosting

BudgetBee Synology NAS Set up 13 new 2023

  • STEP 19

After you press Enter on your Keyboard at STEP 18, you will get a message that says: “User created successfully“. Follow the instructions in the image below.

BudgetBee Synology NAS Set up 13

  • STEP 20

On the left sidebar in Portainer, click Containers. Identify all your BudgetBee instances, select them then click Restart. Follow the instructions in the image below.

BudgetBee Synology NAS Restart Containers

  • STEP 21

Go back to STEP 1 or you will deal with karma 🙂.

  • STEP 22

Now open your browser and type in your HTTPS/SSL certificate like this https://budgetbee.yourname.synology.me In my case it’s https://budgetbee.mariushosting.synology.me If everything goes right, you will see the BudgetBee Sign in page. Type in your own email address and password that you have previously created at STEP 17. Click Sign in. Follow the instructions in the image below.

BudgetBee Synology NAS Set up 14

  • STEP 23

Start using BudgetBee!

BudgetBee Synology NAS Dashboard

  • STEP 24

Your BudgetBee dashboard at a glance!

BudgetBee DashBoard Synology

Enjoy BudgetBee!

🆘TROUBLESHOOTING

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 BudgetBee 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 / February 24th, 2024 at 8:23 PM