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
- Quick Start Guide
- 4. General configuration
- 5. Server-side protocols
- 6. Client-side protocols
- 7. Event handlers
- 7.1. Introduction to event handlers
- 7.2. Local file
- 7.3. File dispatcher
- 7.4. HTTP POST / Webhooks
- 7.5. Email sender
- 7.6. Windows EventLog
- 7.7. Standard output stream
- 7.8. Embedded database
- 7.9. Syslog
- 7.10. Create archive / compress
- 7.11. Extract archive / uncompress
- 7.12. Execute external script or program
- 7.13. Encrypt / decrypt using OpenPGP / GPG
- 7.14. RabbitMQ publisher
- 7.15. File message digest generator
- 7.16. Account interaction
- 7.17. Extension API
- 8. Identity configuration
- 9. User/Admin authentication sources
- 10. Server-side Usage Instructions
- 10.1. Accounts Authentication
- 10.2. Accounts Authorization
- 10.3. Identity and Access Management for administrators (IAM)
- 10.4. Web Manager Console
- 10.5. Public Key Infrastructure (PKI)
- 10.6. FTP/FTPS Usage
- 10.7. SFTP / SCP Usage
- 10.8. HTTP / HTTPS Service
- 10.9. Let's Encrypt Certificate Automation
- 10.10. Command line administration
- 10.11. File system access
- 10.12. Events, Event Handlers and the audit trail
- 10.13. Command-Line Administration-Shell
- 11. Client-side Usage Instructions
- 12. Developer Documentation
- 13. User's Guides
- 13.1. TLS Client Configuration
- 13.2. SSL / TLS / SSH protocols overview
- 13.3. Hardening SFTPPlus Deployments
- 13.4. Resetting Web Manager username and password
- 13.5. Auditing the encryption used for FTPS, SFTP, SCP and HTTPS connections
- 13.6. File Dispatcher Event Handler
- 13.7. Deploying file transfers with Docker containers
- 13.8. Generating and converting SSH keys
- 13.9. Using PGP/GPG encryption and decryption
- 13.10. Interoperability with anti-viruses
- 13.11. Sending notification/alerts over emails
- 10.12. Events, Event Handlers and the audit trail
- 13.12. Managing logs in high volume installations
- 13.13. Using WebDAV
- 13.14. Group inheritance for permissions
- 13.15. Integrating with an LDAP Server
- 13.16. Integrating with fault tolerant and resilient environments
- 13.17. Using WinSCP Client and SFTPPlus Server
- 13.18. Using Filezilla Client with SFTPPlus Server
- 13.19. Testing and Debugging
- 14. Standards, Compliance, Obligation and Certification
Reference
Miscellaneous Topics
The documentation covers the features and functionality for the 5.6.0 release of SFTPPlus, and was last updated on Oct 30, 2024.