How to Install Web Portal on Your Synology NAS

How to Install Web Portal on Your Synology NAS

Web-Portal is a web app written in Python using Quart, that aims to provide an easy and fast way to manage the links to all of your web services. I will show you how to install Web Portal on your Synology NAS using Docker.

šŸ’”Note: This guide works perfectly with the latest Web Portal v2.4.0 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.

Download Container Manager Synology Docker

  • STEP 3

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

Web Portal Synology NAS Set up 1

  • STEP 4

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

Synology User Defined Script

  • STEP 5

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 Web Portal. 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=web-portal \
-p 4855:8000 \
-e DB_URI=sqlite:///data/db.sqlite \
-e SECRET_KEY=mariushosting \
-v /volume1/docker/webportal:/data \
--restart always \
ghcr.io/enchant97/web-portal:2

Note: Before you paste the code above in the Run command area, change the value for SECRET_KEY and add your own secret key. mariushosting is an example for a key. You have to insert your own key.

Web Portal Synology NAS Set up 3 new 2023

  • STEP 6

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

Web Portal Synology NAS Set up 4 new

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

Synology Task Scheduler Confirm Admin Password

  • STEP 7

After you click Submit on STEP 6, select your ā€œInstall Web Portalā€ Task then click the ā€œRunā€ tab. You will be asked to run Install Web Portal ā€“ click OK. Follow the instructions in the image below.

Web Portal Synology NAS Set up 5

  • 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:4855 Click Next to create your own administrator username and password. Follow the instructions in the image below.

Web Portal Synology NAS Set up 5 new

  • STEP 10

Add your own Username and Password then click Next. Follow the instructions in the image below.

Web Portal Synology NAS Set up 6 new

  • STEP 11

Check Public Portal and Show Widget Headers then click Next. Follow the instructions in the image below.

Web Portal Synology NAS Set up 7 new

  • STEP 12

Click Take Me To The Portal. Follow the instructions in the image below.

Web Portal Synology NAS Set up 8 new

  • STEP 13

At the top of the page click Log In then add your own Username and Password you have previously chosen at STEP 10. Follow the instructions in the image below.

Web Portal Synology NAS Set up 9 new

  • STEP 14

Click the gear icon at the top of the page then click Users. Follow the instructions in the image below.

Web Portal Synology NAS Set up 7

  • STEP 15

Create a new user with your own username and password then delete the current default admin. Follow the instructions in the image below.

Web Portal Synology NAS Set up 8

  • STEP 16

Switch to dark theme. Add your first application credentials. In the example below I have added Portainer as an application. Click Save. Follow the instructions in the image below.

Web Portal Synology NAS Set up 9

  • STEP 17

Your first application will look like the one in the image below.

Web Portal Synology NAS Set up 11

Enjoy Web Portal!

Web Portal Synology NAS Set up 12

Enjoy Web Portal!

šŸ†˜TROUBLESHOOTING

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

Note: If you want to run the Web Portal container over HTTPS, check my guide on How to Run Docker Containers Over HTTPS.

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 Web Portal 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 Monday / January 6th, 2025 at 3:57 PM