Documentation
Documentation Start Page¶
SFTPPlus is a multi-protocol, multi-platform managed file transfer solution.
Here is a non-exhaustive list of principles standing at the base of our product:
Multi-protocol
Multi-platform
Both client and server functionality in a single product
Automated and non-interactive client side transfer
Easy to configure and administrate
Can be configured via text file and command line tools
Can be configured using a web-based configuration tool
Stand-alone product without external dependencies - with the exception of the OpenSSL library.
This documentation includes instructions for performing installation, upgrade, configuration, and operational procedures.
The information is written for experienced administrators of Windows or Unix-like systems, familiar with file transfer protocols.
- 1. Introduction
- 2. Install
- 3. Updates and upgrade
- 4. Quick Start Guide
- 5. General configuration
- 5.1. Configuration principles
- 5.2. Configuration file
- 5.3. Web Manager console
- 5.4. Server's process
- 5.5. Matching expressions
- 5.6. Resources
- 5.7. Local file system monitor
- 5.8. Email client
- 5.9. Analytics and alerts
- 5.10. Let's Encrypt client / CertBot
- 5.11. SQLite database
- 5.12. Node synchronization
- 6. Server-side protocols
- 7. Client-side protocols
- 7.1. Transfers
- 7.2. General location options
- 7.3. Local filesystem
- 7.4. SFTP
- 7.5. FTP
- 7.6. Explicit FTPS
- 7.7. Implicit FTPS
- 7.8. HTTP(S) file download
- 7.9. WebDAV / SharePoint Online
- 7.10. AS2
- 7.11. Azure BLOB Service
- 7.12. Azure File Service
- 7.13. SMB / Windows Share
- 7.14. Exchange Online Mailbox
- 7.15. Send files as email attachments
- 8. Event handlers
- 8.1. Introduction to event handlers
- 8.2. Local file
- 8.3. File dispatcher
- 8.4. HTTP POST / Webhooks
- 8.5. Email sender
- 8.6. Windows EventLog
- 8.7. Standard output stream
- 8.8. Embedded database
- 8.9. Syslog
- 8.10. Create archive / compress
- 8.11. Extract archive / uncompress
- 8.12. Execute external script or program
- 8.13. Encrypt / decrypt using OpenPGP / GPG
- 8.14. RabbitMQ publisher
- 8.15. File message digest generator
- 8.16. Account interaction
- 8.17. Extension API
- 9. Identity configuration
- 10. User/Admin authentication sources
- 10.1. Authentication methods introduction
- 10.2. SFTPPlus embedded users
- 10.3. Operating system / Domain users
- 10.4. HTTP web service
- 10.5. External local file
- 10.6. LDAP / Active Directory
- 10.7. Microsoft Entra ID
- 10.8. Google Identity
- 10.9. Okta OpenID Connect
- 10.10. RADIUS
- 10.11. Banning users
- 10.12. Banning IP addresses
- 10.13. Anonymous users
- 11. Server-side Usage Instructions
- 11.1. Accounts Authentication
- 11.2. Accounts Authorization
- 11.3. Identity and Access Management for administrators (IAM)
- 11.4. Web Manager Console
- 11.5. Public Key Infrastructure (PKI)
- 11.6. FTP/FTPS Usage
- 11.7. SFTP / SCP Usage
- 11.8. HTTP / HTTPS Service
- 11.9. Let's Encrypt Certificate Automation
- 11.10. Command line administration
- 11.11. File system access
- 11.12. Events, Event Handlers and the audit trail
- 11.13. Command-Line Administration-Shell
- 12. Client-side Usage Instructions
- 13. Developer Documentation
- 14. User's Guides
- 14.1. TLS Client Configuration
- 14.2. SSL / TLS / SSH protocols overview
- 14.3. Hardening SFTPPlus Deployments
- 14.4. Resetting Web Manager username and password
- 14.5. Auditing the encryption used for FTPS, SFTP, SCP and HTTPS connections
- 14.6. File Dispatcher Event Handler
- 14.7. Deploying file transfers with Docker containers
- 14.8. Generating and converting SSH keys
- 14.9. Using PGP/GPG encryption and decryption
- 14.10. Interoperability with anti-viruses
- 14.11. Sending notification/alerts over emails
- 11.12. Events, Event Handlers and the audit trail
- 14.12. Managing logs in high volume installations
- 14.13. Using WebDAV
- 14.14. Group inheritance for permissions
- 14.15. Integrating with an LDAP Server
- 14.16. Integrating with fault tolerant and resilient environments
- 14.17. Using WinSCP Client and SFTPPlus Server
- 14.18. Using Filezilla Client with SFTPPlus Server
- 14.19. Testing and Debugging
- 15. Standards, Compliance, Obligation and Certification
Reference
Miscellaneous Topics
The documentation covers the features and functionality for the 5.12.0 release of SFTPPlus, and was last updated on Apr 11, 2025.