How to Install Hoppscotch on Your Synology NAS

How to Install Hoppscotch on Your Synology NAS

Hoppscotch is a tool that helps you build HTTP requests that you send to servers. This tool allows you to work easily with APIs. The best alternative to Hoppscotch is Yaade. In this step by step guide I will show you how to install Hoppscotch on your Synology NAS using Docker.

💡Note: This guide works perfectly with the latest Hoppscotch v2023.12.6 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 hoppscotch. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Hoppscotch Synology NAS Set up 1

  • STEP 4

Now create ten new folders inside the hoppscotch folder that you created at STEP 3 name them assets, components, directives, helpers, layouts, middleware, pages, plugins, static, store. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Hoppscotch Synology NAS Set up 2

  • STEP 5

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

Synology User Defined Script

  • 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 Hoppscotch. 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=hoppscotch \
-p 3771:3000 \
-v /volume1/docker/hoppscotch:/app/.hoppscotch \
-v /volume1/docker/hoppscotch/assets:/app/assets \
-v /volume1/docker/hoppscotch/directives:/app/directives \
-v /volume1/docker/hoppscotch/layouts:/app/layouts \
-v /volume1/docker/hoppscotch/middleware:/app/middleware \
-v /volume1/docker/hoppscotch/pages:/app/pages \
-v /volume1/docker/hoppscotch/plugins:/app/plugins \
-v /volume1/docker/hoppscotch/static:/app/static \
-v /volume1/docker/hoppscotch/store:/app/store \
-v /volume1/docker/hoppscotch/components:/app/components \
-v /volume1/docker/hoppscotch/helpers:/app/helpers \
--restart always \
hoppscotch/hoppscotch

Hoppscotch Synology NAS Set up 4 new 2023

  • STEP 7

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

Hoppscotch Synology NAS Set up 5

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 8

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

Hoppscotch Synology NAS Set up 6

  • 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. It will depend on your Internet speed connection. Now open your browser and type in http://Synology-ip-address:3771 Follow the instructions in the image below.

Hoppscotch Synology NAS Set up 7

Enjoy Hoppscotch!

Hoppscotch Synology NAS Set up 8

🆘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 Hoppscotch container over HTTPS, check my guide on How to Run Docker Containers Over HTTPS. In order to make Hoppscotch work via HTTPS, it’s mandatory to activate WebSocket.

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 Hoppscotch 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 Wednesday / March 6th, 2024 at 11:08 AM