Files
custom-portainer-configurat…/templates/sftpgo/README.md
Nathan Falvey 7389e6ed96 fix: 📝 Fixed sftp config readme
Added a detailed explanation inside the README for the sftpgo configuration, this contains an extra step for synology users.
2026-03-04 14:34:01 +00:00

36 lines
1.6 KiB
Markdown

# SFTPGo (Portainer template)
SFTPGo is a fully featured and highly configurable storage routing server with SFTP, HTTP/S, FTP/S and WebDAV support. It allows you to securely share files with local and remote users.
Quick notes:
- **Protocols**: Supports SFTP, FTP/S, WebDAV, and a built-in Web UI for file management.
- **Storage**: Can serve local storage, S3, Google Cloud Storage, and Azure Blob.
- **Authentication**: Supports multiple backends including SQLite, MySQL, PostgreSQL, and LDAP/OIDC.
Usage:
1. Import the compose file into Portainer's Stacks or App Templates.
2. Configure the environment variables for the initial admin user and database settings.
3. Map the data volume to persist user data and configuration. (See Extra Note)
4. Deploy the stack via Portainer.
5. Access the admin web interface at `http://<your-ip>:8080/web/admin`.
Helpful links:
- GitHub Repository: https://github.com/drakkan/sftpgo
- Documentation: https://github.com/drakkan/sftpgo/tree/main/docs
Extra Note:
Using a portainer install on a Synology Nas requires some extra folder permission configuration. You must give the data folder read and write permissions to everyone. This can be done with:
1. Open **File Station** on your Synology NAS.
2. Right-click the folder mapped to SFTPGo and select **Properties**.
3. Go to the **Permission** tab.
4. Click **Create** or **Edit** to add the `Everyone` group.
5. Check **Read** and **Write** permissions.
6. Check the box **Apply to this folder, sub-folders and files**.
7. Click **Done** and **Save**.
**Status:** Ready for configuration