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.
This guide works perfectly with the latest Web Portal v2.3.1 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 webportal. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.
STEP 4
Go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script. Follow the instructions in the image below.
STEP 5
Once you click on User-defined script, a new window will open. Follow the instructions below:
- General: In the Task field type in Install Web Portal. Uncheck the “Enabled” option. Select root User.
- Schedule: Select Run on the following date then select “Do not repeat“.
- 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:2Note: 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.
STEP 6
After you click OK on STEP 5 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 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.
STEP 8
Go back to STEP 1 or you will deal with karma 🙂
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.
STEP 10
Add your own Username and Password then click Next. Follow the instructions in the image below.
STEP 11
Check Public Portal and Show Widget Headers then click Next. Follow the instructions in the image below.
STEP 12
Click Take Me To The Portal. Follow the instructions in the image below.
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.
STEP 14
Click the gear icon at the top of the page then click Users. Follow the instructions in the image below.
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.
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.
STEP 17
Your first application will look like the one in the image below.
Enjoy Web Portal!
Enjoy Web Portal!
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 / April 22nd, 2024 at 4:31 PM