INI configuration file

SFTPPlus MFT stores its configuration in a unified .INI file. Every setting available through the Web Manager or command-line tools can also be managed directly in this file.

INI configuration example ​

The following example defines an SFTP service and an event handler that writes activity logs to a local file:

ini
[services/sftp-1]
enabled = Yes
name = sftp-service
type = ssh
description = Example of an SFTP-only service.
address = 0.0.0.0
port = 10022
ssh_cipher_list = secure
banner = Welcome to the SFTP Service.
ignore_create_permissions = No

[event-handlers/DEFAULT-FILE]
enabled = Yes
name = Log File
description = Append logs to a file on the local filesystem.
type = local-file
; Path where logs are stored.
path = log/server.log

Direct and transparent configuration ​

The plain text format gives administrators direct access to the complete SFTPPlus configuration. It is easy to read, edit, copy, and compare without requiring a proprietary configuration tool.

The same file can define:

  • File transfer services and automated transfers
  • Users, groups, and authentication methods
  • Storage locations and file processing rules
  • Event handlers and audit settings
  • Administrative access and security policies

Review and recover changes ​

Because the configuration is stored as text, changes can be reviewed and tracked over time. You can keep backup copies, compare revisions, and restore a known configuration when needed.

The file can also be stored in a version control system, subject to your organisation's policy for protecting credentials and other sensitive values.

Administrators can use this workflow for both individual installations and repeatable deployments.

Automate deployments ​

The .INI format works with configuration management and orchestration tools such as Ansible, CloudFormation, Kubernetes, and OpenShift. Teams can prepare and review configuration changes before deployment, then apply the same configuration consistently across environments.

For container and Kubernetes deployments, the configuration can be supplied through the platform's normal configuration mechanisms, including Kubernetes ConfigMaps.

Use your preferred management method ​

Use the INI configuration file when you need direct editing, version control, or infrastructure-as-code deployments. The Web Manager is suited to interactive administration and monitoring, while the command-line tools support text-based, automated, and repeatable operations.