Welcome to the SFTPPlus MFT trial

Getting started with SFTPPlus on Linux Switch to the Windows guide?


Download and installation steps.

Open your terminal and change the directory to where you downloaded the SFTPPlus package.

      $ ls
      $ tar xf sftpplus-linux-x64-trial.tar.gz

To complete the installation, we will generate the SSH keys and a simple configuration file.

      $ cd sftpplus-linux-x64-trial
      $ ./bin/admin-commands.sh initialize

Add a configuration file and start the service.

In order to explore the SFTPPlus features, we will provide a configuration file for a test account test_user with the password test_password, and will enable the SFTP/SCP service.

We prepared a configuration file example to start with. This file includes a couple of sections, the minimum to get us started. Use the content below to create a text file in the current path at configuration/server-cli.ini. SFTPPlus comes with extensive documentation for all of the sections:

; Application authentication method
enabled = Yes
type = application
name = Application Accounts

; User account home folder and credentials.
name = test_user
type = application
enabled = Yes
home_folder_path = /tmp/sftpplus-test/
; This is the encrypted version for value 'test_password'.
password = $5$DfjfEI8R1.fpGQg9$A95Q7ENuO2Bfk95k8gCwOP6YzWmVe8vTz2fcPkGpmp6

; User account default group.
enabled = Yes
lock_in_home_folder = Yes

; SFTP/SCP service
enabled = Yes
name = SFTP Server
type = ssh
sftp = Yes
scp = Yes
address =
port = 10022
rsa_private_key = configuration/ssh_host_rsa_key
rsa_private_key_password = Disabled
dsa_private_key = configuration/ssh_host_dsa_key
dsa_private_key_password = Disabled
primes = configuration/ssh-service.moduli
ssh_cipher_list = all
authentications = app-user-auth-id

Now let's create the server folders and start the service. SFTPPlus will provide detailed information about the services, connections and errors if there will be any.

      $ mkdir /tmp/sftpplus-test/
      $ ./bin/admin-commands.sh debug -c configuration/server-cli.ini

Connect to the server and upload a file.

You can use a graphical SFTP client or the command line scp(1) remote file copy program provided by most of the modern Linux distributions to upload and download the files. In the example below, the transferred file will be stored at /tmp/sftpplus-test/README-sftp-test, to run it, open a new console window.

      $ scp -P 10022 doc/README test_user@
      $ ls -l /tmp/sftpplus-test/README-sftp-test

To download the file, use the scp(1) command line remote file copy program.

      $ scp -P 10022 test_user@ README-sftp-downloaded
      $ ls -l README-sftp-downloaded

Enable the file transfer automations.

SFTPPlus provides a powerful framework for pre- and post-transfer operations. Here is an example on how to automate SFTPPlus to move files after transfers to a new location. Just extend the initial configuration with the section below.

; File transfer automation
name = Rename files after transfer
type = move
source_path = /tmp/sftpplus-test/
destination_path = /tmp/sftpplus-backup/

You can stop the server by pressing CTRL + C. Before we start again the server to use the new configuration changes, we need to create the destination path. To resume the server, just follow the same instructions as we did in the beginning.

      $ mkdir /tmp/sftpplus-backup/
      $ ./bin/admin-commands.sh debug -c configuration/server-cli.ini

The transfer automation will move any uploaded files from its source location (in our case the account home folder) to the destination folder shortly after the uploads complete. SFTPPlus will log any errors and will retry a couple of times in case of failures.


Support and feedback.

This guide is complete. We would like to thank you for your time. SFTPPlus comes with free support during the trial period. If you have questions or feedback, we would like to hear from you.