How to Install SFTPGo on Your Synology NAS

How to Install SFTPGo on Your Synology NAS

SFTPGo is a full-featured and highly configurable event-driven file transfer solution. It supports the following server protocols: SFTP, HTTP/S, FTP/S, WebDAV and the following storage backends: local filesystem, encrypted local filesystem, S3 (compatible) Object Storage, Google Cloud Storage, Azure Blob Storage, other SFTP servers. With SFTPGo you can leverage local and cloud storage backends for exchanging and storing files internally or with business partners using the same tools and processes you are already familiar with. The WebAdmin UI allows to easily create and manage your users, folders, groups and other resources. The WebClient UI allows end users to change their credentials, browse and manage their files in the browser and setup two-factor authentication which works with Microsoft Authenticator, Google Authenticator, Authy and other compatible apps. In this step by step guide I will show you how to install SFTPGo on your Synology NAS using Docker and Portainer.

💡Note: This guide works perfectly with the latest SFTPGo v2.6.2 release.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

  • 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 File Station and open the docker folder. Inside the docker folder, create one new folder and name it sftpgo. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

SFTPGo Synology NAS Set up 1

  • STEP 5

Now create two new folders inside the sftpgo folder that you created at STEP 4 and name them data and db. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

SFTPGo Synology NAS Set up 2

  • STEP 6

Right click on the sftpgo folder that you have previously created at STEP 4 then click Properties. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 3

  • STEP 7

Go to the Permission tab then click Advanced options. From the drop-down menu choose “Make inherited permissions explicit“. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 4

  • STEP 8

Select Everyone then click the Edit tab. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 5

  • STEP 9

Check all Read and Write Permissions. Click Done. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 6

  • STEP 10

After you click Done on STEP 9, check “Apply to this folder, sub-folders and files“. Click Save. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 7

  • STEP 11

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

1 Synology Portainer Add Stack

  • STEP 12

In the Name field type in sftpgo. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

version: '3.9'
services:
  sftpgo:
    image: drakkan/sftpgo:latest
    user: 1000:1000
    container_name: SFTPGo
    ports:
      - 8813:8080 # HTTP
      - 2022:2022 # SFTP
    environment:
      SFTPGO_WEBDAVD__BINDINGS__0__PORT: 5007
      SFTPGO_DATA_PROVIDER__DRIVER: mysql
      SFTPGO_DATA_PROVIDER__NAME: sftpgo
      SFTPGO_DATA_PROVIDER__HOST: mysql
      SFTPGO_DATA_PROVIDER__PORT: 3306
      SFTPGO_DATA_PROVIDER__USERNAME: marius
      SFTPGO_DATA_PROVIDER__PASSWORD: mariushosting
      SFTPGO_COMMON__DEFENDER__ENABLED: true
      SFTPGO_COMMON__DEFENDER__BAN_TIME: 15
      SFTPGO_COMMON__DEFENDER__BAN_TIME_INCREMENT: 100
      SFTPGO_COMMON__DEFENDER__THRESHOLD: 5
      SFTPGO_COMMON__DEFENDER__OBSERVATION_TIME: 15
    volumes:
      - /volume1/docker/sftpgo/data:/srv/sftpgo:rw
    restart: on-failure:5 

  mysql:
    image: mariadb:11.3-jammy
    container_name: SFTPGo-DB
    environment:
      TZ: Europe/Bucharest
      MYSQL_DATABASE: sftpgo
      MYSQL_USER: marius
      MYSQL_PASSWORD: mariushosting
      MYSQL_ROOT_PASSWORD: rootpass
    volumes:
      - /volume1/docker/sftpgo/db:/var/lib/mysql:rw
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)
Note: Before you paste the code above in the Web editor area below, change the value for SFTPGO_DATA_PROVIDER__USERNAME and MYSQL_USER. marius is an example for a username. The user should be the same for both values.
Note: Before you paste the code above in the Web editor area below, change the value for SFTPGO_DATA_PROVIDER__PASSWORD and MYSQL_PASSWORD. mariushosting is an example for a password. The password should be the same for both values.

SFTPGo Synology NAS Set up 8

  • STEP 13

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

SFTPGo Synology NAS Set up 9

  • STEP 14

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

SFTPGo Synology NAS Set up 10

  • STEP 15

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

  • STEP 16

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:8813 Create a new WebAdmin user and password, then click Create admin and Sign in. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 11

  • STEP 17

On the left sidebar, click Users then +Add. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 12

  • STEP 18

Type in a new username and password for the WebClient interface, then scroll down the page. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 13

  • STEP 19

Select Local disk as Storage, then type in /srv/sftpgo for the Root directory, then click Save. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 14

  • STEP 20

At the top right of the page, click the user icon then Sign out. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 15

  • STEP 21

Click Go to WebClient, then type in the username and password for the user that you have previously created at STEP 18. Click Sign in. Follow the instructions in the image below.
💡Remember: The admin interface (WebAdmin) will be available at the following address: http://Synology-ip-address:8813/web/admin/login and the client interface (WebClient) will be available at the following address: http://Synology-ip-address:8813/web/client/login

SFTPGo Synology NAS Set up 16

  • STEP 22

Upload your files. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 17

  • STEP 23

After the files are uploaded, click Save. Follow the instructions in the image below.

SFTPGo Synology NAS Set up 18

  • STEP 24

The files will be available in your data folder that you have previously created at STEP 5. 💡Remember: You can upload your files in this folder via File Station and the user that you have previously created at STEP 18 will be able to see all the files via the awesome WebClient interface and download them.

SFTPGo Synology NAS Set up 19

Enjoy SFTPGo!

🆘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 SFTPGo container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make SFTPGo 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 SFTPGo 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 Saturday / July 13th, 2024 at 4:32 AM