SFTPPlus

Client Documentation

Start Page › 3. Configuration instructions › 3.8. Global configuration settings

3.8. Global configuration settings

SFTPPlus Clients provides a set of configuration options which affect all transfers. These options are defined inside the global.conf configuration file located in the root folder of SFTPPlus Client installation.

3.8.1. Defining absolute inbox folder paths

By default, local folders used by the SFTPPlus Client to get or put files are located inside the /opt/SFTPPlus-client/inbox folder. To allow monitoring local folders outside of the /opt/SFTPPlus-client/inbox folder, you will have to modify the /opt/SFTPPlus-client/global.conf file and replace:

global.inbox = mypath || 'inbox' || sepchar

with:

global.inbox = ''

3.8.2. Global options

This section describes available global configuration options.

3.8.2.1. global.directoryscantime

Optional:

No
Default value:

10
Values:
  • Number of seconds.
From version:

1.5.1
To version:

None
Description:

Default number of seconds between successive scans of new files in local folders. This option can be overwritten for each separate transfer. See Transfer scheduling.

3.8.2.2. global.remotedirectoryscantime

Optional:

No
Default value:

86400
Values:
  • Number of seconds.
From version:

1.5.1
To version:

None
Description:

Default number of seconds to wait between scans of new files in local folders. This is set to 1 day (86400 seconds). This option can be overwritten for each separate transfer. See Transfer scheduling.

3.8.2.3. global.connect_timeout

Optional:

No
Default value:

300
Values:
  • Number of seconds.
From version:

1.5.39
To version:

None
Description:

Number of seconds to wait before dropping connection for a slow server which does not respond to initial connection request. Note that this timeout is only active during the connection initialization phase. It does not affect an active transfer.

3.8.2.4. global.maximum_transfer_duration

Optional:

No
Default value:

21600
Values:
  • Number of seconds.
From version:

1.5.39
To version:

None
Description:

Number of seconds to wait before dropping connection for a server performing a slow transfer. This is the total amount of seconds a transfer is allowed to execute. The connection will be dropped even if the transfer is still active, and (slowly) transferring data. Default to 6 hours.

3.8.2.5. global.force_regex

Optional:

Yes
Default value:

‘n’
Values:
  • ‘y’
  • ‘n’
From version:

1.5.38
To version:

None
Description:

By default, SFTPPlus Client uses a superset of Unix globing file matching. Setting this to ‘y’ will enable support for full RegEx expressions.

3.8.2.6. global.large_files

Optional:

Yes
Default value:

‘n’
Values:
  • ‘y’
  • ‘n’
From version:

1.5.41
To version:

None
Description:

By default, SFTPPlus Client internal file handling only supports files with sizes less than 2GB.

When set to ‘y’ SFTPPlus Client will handle files greater than 2GB using external tools provided by the operating system.
‹ 3.7. Transfer scheduling
 
3.9. Connecting to remote servers using a proxy server ›
Send us feedback for this page.