Budibase is an all-in-one low-code platform for building, designing, and automating business apps, such as; admin panels, forms, internal tools, client portals, and more. Before Budibase, it could take developers weeks to build simple CRUD apps; with Budibase, building CRUD apps takes minutes. In this step by step guide I will show you how to install Budibase on your Synology NAS using Docker.

💡Note: This guide works perfectly with the latest Budibase v3.2.5 release.

• STEP 1

Please Support My work by Making a Donation.

• STEP 2

Install Container Manager via Synology “Package Center”. If you run an older DSM version (under 7.2), search for Docker instead of Container Manager.

• STEP 3

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

• STEP 4

Now create two new folders inside the budibase folder that you created at STEP 3 and name them data and db. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

• STEP 5

Go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script. Follow the instructions in the image below.

• STEP 6

Once you click on User-defined script, a new window will open. Follow the instructions below:

1. General: In the Task field type in Install Budibase. Uncheck the “Enabled” option. Select root User.
2. Schedule: Select Run on the following date then select “Do not repeat“.
3. Task Settings: Check “Send run details by email“, add your email then copy paste the code below in the Run command area. After that, click OK.

docker run -d --name=budibase \
-p 10000:80 \
-v /volume1/docker/budibase/data:/data \
-v /volume1/docker/budibase/db:/opt/couchdb/data \
--restart always \
budibase/budibase

• STEP 7

After you click OK on STEP 6 a new warning pop up window will open. Click OK.

After you click OK, type in your DSM Password then click Submit. Follow the instructions in the image below.

• STEP 8

After you click Submit on STEP 7, select your “Install Budibase” Task then click the “Run” tab. You will be asked to run Install Budibase – click OK. Follow the instructions in the image below.

• STEP 9

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

• STEP 10

The installation process can take up to a few seconds/minutes because you need to download the image that is approximately 2GB. It will depend on your Internet speed connection. Now open your browser and type in http://Synology-ip-address:10000 Type in your own Email and a Password. Click Create super admin user. Follow the instructions in the image below.

• STEP 11

Type in your own Email and Password that you have previously chosen at STEP 10, then click Log in to Budibase. Follow the instructions in the image below.

• STEP 12

Choose a Name and URL slug address for your APP then click Lets go!. Follow the instructions in the image below.

• STEP 13

Click Budibase Sample data if you don’t have any other data. Follow the instructions in the image below.

• STEP 14

At the top left of the page click the 3 horizontal lines then Access. Follow the instructions in the image below.

• STEP 15

Click the Settings tab, then add your SMTP email to allow your app to benefit from automated auth emails. Follow my step by step guide on how to activate SMTP for your Gmail account.💡Note: If you don’t want to use the easiest way for SMTP with Google and you already have SMTP details from your own Mail Server, you can just use your personalized email SMTP details instead.

• STEP 16

Click the Apps tab, then select your favorite template. Click Use template. Follow the instructions in the image below.

• STEP 17

Choose a Name and URL slug address for your APP then click Create app. Follow the instructions in the image below.

• STEP 18

Modify the template according to your preferences. You can modify the Data and Design by going to each tab. At the top right of the page click Publish. Follow the instructions in the image below.

• STEP 19

After you click Publish at STEP 18, confirm again. Click Publish. Follow the instructions in the image below.

• STEP 20

Click View App. You can view your app at the specified URL. Follow the instructions in the image below.

• STEP 21

Your app is now live!

• STEP 22

If you want to run the Budibase container over HTTPS, check my guide on How to Run Docker Containers Over HTTPS. In order to make Budibase work over https, it’s also mandatory to set up WebSocket. You can also change your Budibase theme. Follow the instructions in the image below.💡Note: When you add Reverse Proxy to the Budibase container, all of your app URLs will be automatically changed to HTTPS.

Enjoy Budibase!

🆘TROUBLESHOOTING

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

Note: Read the full budibase documentation.

Note: Best Practices When Using Docker and DDNS.
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 Budibase 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 Tuesday / November 19th, 2024 at 1:38 PM