How to Install Sshwifty on Your Synology NAS

How to Install Sshwifty on Your Synology NAS

Sshwifty is a SSH and Telnet connector made for the Web. It can be deployed on your computer or server to provide SSH and Telnet access interface for any compatible (standard) web browser. Sshwifty is a great free alternative to Shellngn. In this step by step guide I will show you how to install Sshwifty on your Synology NAS using Docker.

💡Note: This guide works perfectly with the latest Sshwifty 0.3.14 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

Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.

  • STEP 4

Go to Control Panel / Login Portal / Advanced Tab / click Reverse Proxy. Follow the instructions in the image below.

Sshwifty Synology NAS Set up 1

  • STEP 5

Now click the “Create” button. Follow the instructions in the image below.

Sshwifty Synology NAS Set up 2

  • STEP 6

After you click the Create button, the window below will open. Follow the instructions in the image below.

On the General area, set the Reverse Proxy Name description: type in Sshwifty. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: ssh.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 8182

Sshwifty Synology NAS Set up 3

  • STEP 7

On the Reverse Proxy Rules click the Custom Header tab. Click Create and then, from the drop-down menu, click WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. Click Save. Follow the instructions in the image below.

Synology Proxy WebSocket

  • STEP 8

Go to Control Panel / Network / Connectivity / Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

Sshwifty Synology NAS Set up 5

  • STEP 9

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP Compression then click Apply. Follow the instructions in the image below.

Sshwifty Synology NAS Set up 5 new

  • STEP 10

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

Synology User Defined Script

  • STEP 11

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 Sshwifty. 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=sshwifty \
-p 8182:8182 \
--restart always \
niruix/sshwifty

Sshwifty Synology NAS Set up 7 new 2023

  • STEP 12

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

Sshwifty Synology NAS Set up 8

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 13

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

Sshwifty Synology NAS Set up 9

  • STEP 14

Enable SSH service on port 22 then click Apply. Follow the instructions in the image below.

Sshwifty Synology NAS Set up 10

  • STEP 15

Adjust your Synology NAS Firewall. Go to Control Panel / Security / Firewall Tab / Click Edit Rules. In your current Firewall rules, create a new rule for the Encrypted terminal app. Follow the instructions in the image below. ⚠️Remember: your Encrypted terminal rule should be ABOVE the latest deny rule. Move it from the last position to first position.

Synology SSH port 22 Firewall Rule

  • STEP 16

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

  • STEP 17

Now open your browser and type in your HTTPS/SSL certificate like this https://ssh.yourname.synology.me In my case it’s https://ssh.mariushosting.synology.me at the top left click the + button. Follow the instructions in the image below.

Sshwifty Synology NAS Set up 11

  • STEP 18

Select your connection method: Telnet or SSH. In the example below I will be using SSH. Follow the instructions in the image below.

Sshwifty Synology NAS Set up 12

  • STEP 19

Add your NAS admin User. Add your own IP or synology.me DDNS followed by :22
Select Password as Authentication method. Select utf-8 as Encoding method. Click Connect. Follow the instructions in the image below.
Note: utf-8 is the encoding method for DSM. If you connect to other Operating Systems, remember to add the appropriate encoding method.
Note: Remember to adjust the Firewall on the NAS to avoid connection problems.

Sshwifty Synology NAS Set up 13 new 2024

  • STEP 20

You will be asked if you recognize this server. Click Yes, I do. Follow the instructions in the image below.

Sshwifty Synology NAS Set up 14

  • STEP 21

You will be asked for your NAS Administrator Password. Type it in then click Login. Follow the instructions in the image below.

Sshwifty Synology NAS Set up 15

Enjoy Sshwifty!

Note: With Sshwifty you can connect to multiple devices ad the same time.

Sshwifty Synology NAS Set up 16

Your connection status at a glance!

Sshwifty Synology NAS Set up 17

  • STEP 22

If you decide to uninstall the Sshwifty container, at STEP 15, remember to uncheck the Encrypted terminal app and remove the firewall rule for port 22.

🆘TROUBLESHOOTING

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

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 Sshwifty 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 / September 30th, 2024 at 12:17 PM