This is the list of all changes for SFTPPlus releases, ordered by release number (not by release date).
Please consult the documentation for upgrade instructions.
With the move to dynamic log handlers, all configuration option from [log] section are ignored and new log handlers are required to be configured.
The upgrade procedure will depend on the current version installed:
The upgrade steps involve only updating the configuration files and for most customers will be straightforward. We will guide you as necessary.
Due to the configuration changes that were merged in this version, the upgrade from any previous version of SFTPPlus Server to version 2.0.0 can only be done by uninstalling the product and installing the new version.
Note
In order to be able to reconfigure the server after upgrade, do not delete the configuration files.
The following manual changes are required for the ‘configuration/server.config’ file:
configuration/server.config has been renamed to configuration/server.ini. Having .ini extension, the configuration file should be automatically associated with a text editor. The rename is optional on Unix/Linux since the Unix init script can work with any filename.
[services], renamed to [server]
Removed services_ prefix from all configuration options.
The new [server] section has new attributes uuid, name, description. For more details see documentation.
Renamed APPLICATION_GROUP to DEFAULT_GROUP.
DEFAULT_GROUP is automatically associated to all accounts for which a group was not explicitly defined. These are operating system accounts not defined in the configuration file or legacy SFTPPlus WebAdmin accounts.
OS_GROUP is now a normal group and accounts are not automatically associated to this group. We recommend renaming it to ‘os_group’ to hint that it is just a normal.
${DEFAULT_GROUP} placeholder was renamed to ${DEFAULT_OS_GROUP}. The new name should make it clear that it is referring to a group name as defined in the operating system.
${DEFAULT_USER} placeholder has been renamed ${DEFAULT_OS_USER}. The new name should make it clear that it is referring to an account name as defined in the operating system.
Services configuration are now defined using a new section marker. Each service has now an universally unique identifier (UUID) and a human readable short name. This allows rename operations and operating multiple services in a cluster environment. For more details see documentation.
For example to update the service configuration for a service named ftp-partners having the following configuration:
[ftp-partners]
service_enabled = yes
update it as:
[services/550e8400-e29b-41d4-a716-446655440000]
name = ftp-partners
enabled = yes
Service configuration options have been moved from dedicated files into the main configuration file. All configuration options for the [service] section of each service configuration file need to be copied inside the dedicate section for each service.
Here is an example of service section definition for an FTP protocol:
[services/550e8400-e29b-41d4-a716-446655440000]
name = ftp-partners
enabled = yes
; Protocol options copied from configuration/ftp-service.config file.
banner = Welcome to the FTP/FTPS Service.
passive_port_range = 9000 - 9200
Groups and accounts configuration have been moved from dedicated file into the main configuration file. All accounts and groups should now have an associated UUID. For more information please check the dedicated documentation.
Configuration sections for groups are now in the format [groups/550e8400-e29b-41d4-a716-446655440001], and group name has been as a configuration option. 550e8400-e29b-41d4-a716-446655440001 is the group unique ID.
Configuration sections for accounts are now in the format [accounts/550e8400-e29b-41d4-a716-446655440000] and account name has been moved as a configuration option. 550e8400-e29b-41d4-a716-446655440000 is the account unique ID. This allows renaming for accounts.
Here is an example of new account definition:
[accounts/550e8400-e29b-41d4-a716-446655440000]
name = john
type = application
The following manual changes are required for the ‘configuration/ftp-service.config’ file:
- service_dtp_timeout, renamed to service_idle_data_connection_timeout
The following manual changes are required for the ‘configuration/users.config’ file:
Instead of:
[APPLICATION_GROUP]
enabled: yes
...
[OS_GROUP]
enabled: yes
...
You should have:
[APPLICATION_GROUP]
type: group
enabled: yes
...
[OS_GROUP]
type: group
enabled: yes
...
The following manual changes are required for the ‘configuration/users.config’ file:
When upgrading to version 1.8.0, the ‘configuration/server.config’ file should be changed according to the following notes:
With these changes you can start multiple FTP and SFTP services from a single configuration file.
The following options from ‘configuration/service-ftp.config’ file should be renamed according to this notes:
These changes have been made to create unified configuration options for all services working with SSL/TLS connections. Explicit FTPS will use the same configuration files as the planned Implicit FTPS and HTTPS services which will be added in future updates.
When upgrading to SFTPPlus Server 1.7.14, the ‘configuration/users.config’ file should be changed according to the following rules: