1.1. Guidance for reading the documentation¶

We use the following methods for highlights:

A note supplements and highlights additional information. When ignored, the information presented here will not have any negative consequences. Below is an example of a note message.

A warning is information which should not be ignored. The information should be understood, as otherwise it can lead to irreversible actions and undesirable consequences. Below is an example of a note message.

You will notice certain terms will be colour-coded grey or blue.

Verbatim values represent terms which should be used exactly as documented. For example, a configuration option such as home_folder_path is a verbatim value. It also describes fixed values like disabled, yes or no.

The Input values serve as an example and we expect them to be altered before being used in a certain configuration.

For example, c:\Path\${USER} is expected to be modified to suit the environment used by a specific deployment, like E:FTP-Files${USER}.

In the documentation you will find scripts, text configuration examples and commands to provide further guidance to our readers.

Example of system administrator commands:

$ ./bin/admin-commands.sh start --configuration non-root-server.ini
# ./bin/admin-commands.sh start --configuration root-server.ini
CMD> service-start.bat --configuration windows-server.ini

Example of a single configuration option defined inside our configuration file:

[section-name/03288e36-cf6b-4bd5-a9be-f421372f17e6]
rotate_count = 5

Example of a command sent to our interactive client shell:

> set username mary

Example of code in the developer documentation:

{
  "account": {
    "home_folder_path": "/local/path/for/account",
    "uuid": "ebfbee04-17be-4d9f-b7fc-20ffed6a61a8",
    "create_home_folder": true,
    "create_home_folder_owner": "ude_team",
    "create_home_folder_group": "partners"
    "home_folder_structure": [['/some-child'], ['/another-child']]
    }
}

1.2. Product development¶

For the SFTPPlus development operations, security, correctness, easy-of-use, and high functionality are all important factors and we focus on them in this order.

To assure correct functionality of SFTPPlus, we are continually re-building the product after each change and run an automated test suite. The software is tested at the source code level as well as at the system level on all supported operating systems and hardware architectures.