Portainer Templates logo

Portainer Templates

SFTPGo SFTPGo

Stack

Object Storage

SFTPGo - the upload portal for Miget Buckets: create users whose storage IS an S3 bucket (custom endpoint, path-style, optional key prefix per user), give outsiders share-upload links, and optionally front it all with SFTP or WebDAV.

Image details

Pulls: 39.3M
Architecture: amd64, arm64, arm/v7, ppc64le, arm64/v8
Image size: 95 MB
Latest: 2.7.x-plugins
User: drakkan
Created: Oct 13, 2020
Updated: 23 minutes ago
Status: active

Source details

Repo: drakkan/sftpgo
Stars: 12.6k
Forks: 966
Language: Go
License: AGPL-3.0
Latest: v2.7.6 · 5 days ago
Updated: 41 minutes ago
Website: sftpgo.com/

Configuration

Type
Compose
Platform
linux
Image
drakkan/sftpgo:v2.7.5
Ports
5000:50002022
Volumes
/var/lib/sftpgo : sftpgodata/srv/sftpgo : sftpgohome
Env vars
SFTPGO_HTTPD__BINDINGS__0__ADDRESS=0.0.0.0SFTPGO_HTTPD__BINDINGS__0__PORT=5000SFTPGO_SFTPD__BINDINGS__0__PORT=2022SFTPGO_DATA_PROVIDER__CREATE_DEFAULT_ADMIN=trueSFTPGO_DEFAULT_ADMIN_USERNAME=${ADMIN_USERNAME:-admin}SFTPGO_DEFAULT_ADMIN_PASSWORD=${ADMIN_PASSWORD}ADMIN_PASSWORD=''ADMIN_USERNAME=admin
Restart
unless-stopped
Source
Repo

Template by deployable-sh·Source

Report issue

Standalone Install

Select an install method, to see config/commands for deploying SFTPGo

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select SFTPGo, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

name: sftpgo

services:
  sftpgo:
    image: drakkan/sftpgo:v2.7.5
    restart: unless-stopped
    environment:
      SFTPGO_HTTPD__BINDINGS__0__ADDRESS: 0.0.0.0
      SFTPGO_HTTPD__BINDINGS__0__PORT: "5000"
      SFTPGO_SFTPD__BINDINGS__0__PORT: "2022"
      SFTPGO_DATA_PROVIDER__CREATE_DEFAULT_ADMIN: "true"
      SFTPGO_DEFAULT_ADMIN_USERNAME: ${ADMIN_USERNAME:-admin}
      SFTPGO_DEFAULT_ADMIN_PASSWORD: ${ADMIN_PASSWORD}
    ports:
      - "5000:5000"
      - "2022"
    volumes:
      - sftpgodata:/var/lib/sftpgo
      - sftpgohome:/srv/sftpgo

volumes:
  sftpgodata:
  sftpgohome:

Or deploy it directly from the source:

git clone https://github.com/deployable-sh/stacks
cd stacks
docker compose -f sftpgo/compose.yaml up -d

More install options in our documentation, or see drakkan/sftpgo for app-specific guidance.

Supported tags and respective Dockerfile links

What is SFTPGo?

SFTPGo allows you to securely share your files over SFTP and optionally over HTTP/S, FTP/S and WebDAV as well.
Several storage backends are supported: local filesystem, encrypted local filesystem, S3 (compatible) Object Storage, Google Cloud Storage, Azure Blob Storage, other SFTP servers. The storage backends are configurable per user, so you can serve a local directory for a user and an S3 bucket (or part of it) for another one.
SFTPGo also supports virtual folders, a virtual folder can use any of the supported storage backends. So you can have, for example, an S3 user that exposes a Google Cloud Storage bucket (or part of it) on a specified path and an encrypted local filesystem on another one. Virtual folders can be private or shared among multiple users, for shared virtual folders you can define different quota limits for each user.
The SFTPGo WebClient allows end users to change their credentials, browse and manage their files in the browser and setup two-factor authentication which works with Authy, Google Authenticator and other compatible apps. From the WebClient each authorized user can also create HTTP/S links to externally share files and folders securely, by setting limits to the number of downloads/uploads, protecting the share with a password, limiting access by source IP address, setting an automatic expiration date.

How to use this image

See the SFTPGo documentation website.

Serve SFTPGo on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying sftpgo.example.com to http://sftpgo:5000

Add this to your Caddyfile

sftpgo.example.com {
	reverse_proxy http://sftpgo:5000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:5000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :5000
  • Stop the other service, or pick a different host port. In 5000:5000 only the left number is yours to change, the right one belongs to the app.

Published on a random port

This template exposes 2022 without setting a host port, so Docker picks a random free one on every deploy.

  • Find it in the Ports column of Portainer's container list, or with docker port <container>

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:5000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, sftpgo can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 5000

Image won't pull

Test the pull directly on the host: docker pull drakkan/sftpgo:v2.7.5

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7, ppc64le, arm64/v8
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

ADMIN_PASSWORD has no default value, and sftpgo may crash or misbehave if left empty.

  • Fill it in on the deploy screen before hitting deploy.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

SFTPGo is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything SFTPGo needs bundled into one download. This template pulls drakkan/sftpgo:v2.7.5, which Docker fetches once (about 95 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. SFTPGo's comes from Docker Hub, published by drakkan.

Version tags

The bit after the colon in the image name is the version tag. This one pins v2.7.5, so every redeploy gives you that exact build until you bump it yourself.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, ppc64le, arm64/v8, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 5000:5000 means it's reachable on port 5000 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 5000:5000
  • 2022, published on a random host port

Volumes

A volume is where SFTPGo keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/sftpgo kept in the sftpgodata volume Docker manages
  • /srv/sftpgo kept in the sftpgohome volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. SFTPGo takes 8 of them, and one needs a value before it'll start properly:

  • SFTPGO_HTTPD__BINDINGS__0__ADDRESS, defaults to 0.0.0.0
  • SFTPGO_HTTPD__BINDINGS__0__PORT, defaults to 5000
  • SFTPGO_SFTPD__BINDINGS__0__PORT, defaults to 2022
  • SFTPGO_DATA_PROVIDER__CREATE_DEFAULT_ADMIN, defaults to true
  • SFTPGO_DEFAULT_ADMIN_USERNAME, defaults to admin
  • SFTPGO_DEFAULT_ADMIN_PASSWORD, pulled from your own environment
  • ADMIN_PASSWORD, needs a value
  • ADMIN_USERNAME, defaults to admin

Restart policy

The restart policy here is unless-stopped, so Docker restarts SFTPGo after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so SFTPGo sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container sftpgo. That's what you'll spot in the containers list and use in commands like docker logs sftpgo.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

SFTPGo is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set SFTPGo up. Add the template list to Portainer once, then deploying SFTPGo is a click rather than a wall of config.