Yaade is an open-source, self-hosted, collaborative API development environment. Even though popular solutions like Hoppscotch exist, their self-hosted app does not come with authentication and relies on Firebase for persistency. Yaade is developed from the ground up with self-hosting and security in mind. That means sensitive information in API requests can safely be stored on your own Synology NAS server. In this step by step guide I will show you how to install Yaade on your Synology NAS using Docker.
Install Docker via Synology “Package Center”.
Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it yaade. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.
Go to Control Panel / Task Scheduler / Create / Scheduled Task / User-defined script. Follow the instructions in the image below.
Once you click on User-defined script, a new window will open. Follow the instructions below:
- General: In the Task field type in Install Yaade. 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=yaade \ -p 9339:9339 \ -e YAADE_ADMIN_USERNAME=mariushosting \ -v /volume1/docker/yaade:/app/data \ --restart always \ esperotech/yaade
Note: Before you paste the code above in the Run command area, change the value for YAADE_ADMIN_USERNAME and add your own username. mariushosting is an example for a username. You have to insert your own username.
After you click OK on STEP 5 a new warning pop up window will open. Click OK.
After you click OK on STEP 6, select your “Install Yaade” Task then click the “Run” tab. You will be asked to run Install Yaade – click Yes. Follow the instructions in the image below.
Go back to STEP 1 or you will deal with karma 🙂
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:9339 Type in your own Username you have chosen at STEP 5. Type in password as the default password. Click Install. Follow the instructions in the image below.
Click the gear icon for the Settings. Go to Account. Change the default password with your own password then click “Change password“. Follow the instructions in the image below.
Note: If you want to run the Yaade 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: Find out how to update the Yaade 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 Thursday / January 26th, 2023 at 3:48 AM