Site

Members

anonymousEnabled :Boolean

Description:

• [FTP/FTPS settings] - If this option is enabled, anonymous access is enabled. This means connections can be made by logging in as an anonymous user rather than as a named user with a password. Anonymous users are represented by the user called 'anonymous'. By default, the home-folder of this user is /Public, so this is the folder that will be publicly accessible if this option is enabled.

  Note that this option is not enabled by default.

  Related properties: anonymousMaxConnections

Source:

• Site.js, line 28

Type:

• Boolean

anonymousHTTPEnabled :Boolean

Description:

• [HTTP/HTTPS settings] - If this option is enabled (which is the default), unauthenticated users will be able to access any file in the public folder. Unauthenticated users are represented by the user called 'anonymous'. By default, the home-folder of this user is /Public, so this is the folder that will be publicly accessible if this option is enabled.

Source:

• Site.js, line 37

Type:

• Boolean

anonymousMaxConnections :Number

Description:

• [FTP/FTPS settings] - The maximum number of simultaneous anonymous connections permitted to the server.

  Note that there will be no limit if this option is set to zero.

  Related properties: anonymousEnabled

Source:

• Site.js, line 393

Type:

• Number

archiveNavEnabled :Boolean

Description:

• [ZIP-file navigation settings] - When this option is enabled, ZIP-files are presented to clients as though they are folders. This means that users can change into folders within the ZIP-file and download specific files. This can save a lot of time and bandwidth as it allows users to download only what they need from a ZIP-file instead of downloading the whole ZIP-file.

  This option is enabled by default.

  Related properties: archiveNavSuffix

Source:

• Site.js, line 51

Type:

• Boolean

archiveNavSuffix :String

Description:

• [ZIP-file navigation settings] - By default, both the ZIP-file itself and the folder that corresponds to the ZIP-file are shown in listings, the latter having the additional extension '.folder'. The additional extension can be changed by modifying this property. If this setting is cleared completely then the ZIP-file won't be displayed being replaced by the corresponding folder.

  Related properties: archiveNavEnabled

Source:

• Site.js, line 263

Type:

• String

autoBanDuration :Number

Description:

• [Auto-banning settings] - The amount of time (in milliseconds) a ban remains in place once an IP address has been autobanned. The default is 3,600,000 milliseconds (1 hour).

  Note that if this option is set to zero, bans will remain indefinitely (i.e. until next server restart).

  Related properties: autoBanTriggerCount, autoBanTriggerPeriod

Source:

• Site.js, line 406

Type:

• Number

autoBanTriggerCount :Number

Description:

• [Auto-banning settings] - The number of authentication failures required to trigger an auto-ban of an IP address, within the failure counting period. The default is 10.

  Related properties: autoBanTriggerPeriod, autoBanDuration

Source:

• Site.js, line 416

Type:

• Number

autoBanTriggerPeriod :Number

Description:

• [Auto-banning settings] - The period of time (in milliseconds) during which if the number of permitted authentication failures is exceeded (from a certain IP address), the IP address is auto-banned for the set ban duration. The default is 60,000 milliseconds (1 minute).

  Related properties: autoBanTriggerCount, autoBanDuration

Source:

• Site.js, line 427

Type:

• Number

backslashPathSep :Boolean

Description:

• [File-system settings] - Unix-style forward slash separators are used in paths by default. Use this setting to enable support for Windows-style backslash separators (while still permitting forward slashes).

  This option is not enabled by default.

Source:

• Site.js, line 61

Type:

• Boolean

(readonly) createdTime :Date

Description:

• The date and time that this site was created.

Source:

• Site.js, line 744

Type:

• Date

defaultDomain :String

Description:

• [General user settings] - If a default Windows domain is set, it means that Windows users on the default domain can login without specifying the domain (instead of using MyDomain\MyUserName they can use MyUserName). This can be very convenient for users.

  The default Windows domain tells CompleteFTP which domain to authenticate against if (1) a domain-name was not given and (2) no exact match was found in CompleteFTP's list of users.

  For Windows users that have been explicitly added to CompleteFTP, if the client tries to log in using a username without a domain-name then the server will first look for this exact username in the config (just like it does now). If a match is not found and a default domain has been set then it tries to prefix the default domain to the username and look up the user-list.

  If the user is not found in the explicitly added list of users and automatic Windows users are enabled, the default domain is again used if the domain name was not specified while logging in. This will result in logging in as 'DefaultDomain\MyUserName'. One consequence of this is that if a default Windows domain has been set then an attempt to log in without specifying a domain name will never log into the local machine. CompleteFTP will always assume the default domain should be used. If the user does want to log into the local machine when a default domain has been set they have to log in using ".\MyUserName".

Source:

• Site.js, line 287

Type:

• String

enabled :Boolean

Description:

• Is this site enabled? If it's not, then the ports used by the site are not open for incoming connections. Disabling a site will kill all connections of users already connected to the site.

  This option is enabled by default.

Source:

• Site.js, line 71

Type:

• Boolean

encoding :String

Description:

• [FTP/FTPS settings] - Character set that is used for encoding file-names. A list of available character sets can be found here. The default is 'utf-8'.

Source:

• Site.js, line 296

Type:

• String

fileEncryptionMode :String

Description:

• [File-system settings] - Controls whether or not stored files are encrypted. If this setting is set to 'GlobalEncryption' and the user has the equivalent setting enabled (see User.fileEncryptionMode), all files transferred to the server will be encrypted on the server (encryption at rest). The only way to decrypt files is by transferring them from the server, or via an administrator command.

  To turn this setting off, set it to 'EncryptionOff' (which is already the default).

Source:

• Site.js, line 794

Type:

• String

fileNameFilter :FileNameFilter

Description:

• [File-system settings] - Allows filename blocking filters to be configured for this site.

Source:

• Site.js, line 303

Type:

• FileNameFilter

ftpEnabled :Boolean

Description:

• [FTP/FTPS settings] - Is the FTP protocol enabled for this site?

  This option is enabled by default.

Source:

• Site.js, line 80

Type:

• Boolean

ftpsEnabled :Boolean

Description:

• [FTP/FTPS settings] - Is the FTPS protocol (explicit mode) enabled for this site?

  This option is enabled by default.

Source:

• Site.js, line 89

Type:

• Boolean

ftpsImplicitEnabled :Boolean

Description:

• [FTP/FTPS settings] - Is the FTPS protocol (implicit mode) enabled for this site? This is a legacy form of FTPS that is still widely used.

  This option is enabled by default.

Source:

• Site.js, line 99

Type:

• Boolean

ftpsVerifyClient :Boolean

Description:

• [FTP/FTPS settings] - This option controls whether or not certificates should be requested from FTPS clients. If they are required then the client must send a certificate that may be validated against the Windows certificate store. This means that its issuer's certificate must be in the Windows 'Trusted root certificate authorities' store.

  This option is not enabled by default.

Source:

• Site.js, line 110

Type:

• Boolean

hideProductVersion :Boolean

Description:

• [Messages settings] - If this option is enabled, the product name and version of the server is not displayed in welcome messages. This may be required for PCI compliance. Note that the default welcome message should also be changed, as it identifies the server.

  This option is not enabled by default.

  Related properties: welcomeMessage

Source:

• Site.js, line 123

Type:

• Boolean

homeDirIsRoot :Boolean

Description:

• [General user settings] - If this option is enabled then the user will see their home directory as the root (i.e. /). If it is disabled then the user will see the absolute virtual file-system path, e.g. "/home/javaftp". By default, this option is not enabled.

Source:

• Site.js, line 132

Type:

• Boolean

htmlErrorTemplate :String

Description:

• [HTTP/HTTPS settings] - Controls the format in which HTTP errors are displayed to the user. The default template uses Javascript to redirect the user to their home folder for 403 errors.

  Note that null will be returned if the template is at default.

Source:

• Site.js, line 313

Type:

• String

htmlListingTemplate :String

Description:

• [HTTP/HTTPS settings] - Controls the format in which directory listings are displayed to the user. Directories may be listed by users by entering a URL specifying the path of a directory. The listing is rendered using HTML containing macros, such as %FileName%.

  Note that null will be returned if the template is at default.

Source:

• Site.js, line 324

Type:

• String

httpBasicAuth :Boolean

Description:

• [HTTP/HTTPS settings] - If this option is enabled then HTTP logins to CompleteFTP will be handled by the browser (usually via HTTP basic authentication) rather than by the CompleteFTP login page. This is not generally recommended as it can cause problems with logouts. SAML Single Sign-On will not work if this option is enabled.

  This option is not enabled by default.

Source:

• Site.js, line 143

Type:

• Boolean

httpEnabled :Boolean

Description:

• [HTTP/HTTPS settings] - Is the HTTP protocol enabled for this site? If enabling, ensure that other HTTP servers are not running on the server machine.

  This option is enabled by default.

Source:

• Site.js, line 153

Type:

• Boolean

httpsEnabled :String

Description:

• [HTTP/HTTPS settings] - Is the HTTPS protocol enabled for this site? If enabling, ensure that other HTTPS servers are not running on the server machine.

  This option is enabled by default.

Source:

• Site.js, line 163

Type:

• String

ipFilter :IPFilter

Description:

• [IP filtering setting] - Allows IP filtering to be configured for this site.

Source:

• Site.js, line 801

Type:

• IPFilter

(readonly) isAdmin :Boolean

Description:

• Is this an admin site?

Source:

• Site.js, line 14

Type:

• Boolean

jssEnabled :Boolean

Description:

• [HTTP/HTTPS settings] - Is server-side Javascript (JSS) enabled for this site? When enabled, JSS files can be placed in user directories and executed as Javascript web applications. JSS must be enabled for the owner of a directory for JSS scripts to be executed (see User.jssEnabled).

  This option is enabled by default.

Source:

• Site.js, line 174

Type:

• Boolean

listingFormat :String

Description:

• [FTP/FTPS settings] - Format of folder listings being sent back to clients. In the FTP protocol folder listings are sent back to the client as plain text. This setting controls the format of this plain text. This is particularly significant for non-console client applications, which usually parse the directory listings automatically.

  Currently, 'Windows', 'Unix' and 'FilenameOnly' are supported. The default is 'Unix'.

Source:

• Site.js, line 336

Type:

• String

maxConnections :Number

Description:

• [Limits and timeouts settings] - The maximum permitted number of simultaneous connections to the site using protocols other than HTTP. If this limit has been reached, any further connection attempts are denied until current connections are closed. The default is zero means that there is no limit.

  This setting does not apply to HTTP connections since HTTP often requires many more concurrent connections. See the separate Site.maxConnectionsHTTP setting.

Source:

• Site.js, line 439

Type:

• Number

maxConnectionsHTTP :Number

Description:

• [Limits and timeouts settings] - Sets the maximum number of simultaneous HTTP connections permitted. The default is 200. If this limit has been reached, any further HTTP connection attempts are denied until current connections are closed.

  If this option is set to zero, there is no limit.

Source:

• Site.js, line 449

Type:

• Number

maxConnectionsPerUser :Number

Description:

• [Limits and timeouts settings] - The maximum permitted number of simultaneous connections for each user (using any protocol). If this limit has been reached, any further connection attempts are denied until current connections are closed. The default is zero means that there is no limit.

Source:

• Site.js, line 458

Type:

• Number

maxLoginAttempts :Number

Description:

• [Limits and timeouts settings] - Sets the maximum number of login attempts that can be made for a user account. The default is 3.

  If this option is set to zero, there is no limit.

Source:

• Site.js, line 467

Type:

• Number

minimumSSLVersion :String

Description:

• [FTPS & HTTPS settings] - This option controls the minimum version of SSL/TLS supported for this site. Available SSL/TLS versions are:

  • 'Ssl3' (SSL 3.0)
  • 'Tls1' (TLS 1.0)
  • 'Tls11' (TLS 1.1)
  • 'Tls12' (TLS 1.2)

  The default is 'Tls1', which means that SSL 3.0 is not supported by default. This ensures that the server is not vulnerable to the security flaws of SSL 3.0.

  Note that this setting is shared between FTPS and HTTPS, both of which use SSL/TLS.

Source:

• Site.js, line 484

Type:

• String

(readonly) modifiedTime :Date

Description:

• The date and time that this site was last modified.

Source:

• Site.js, line 752

Type:

• Date

name :String

Description:

• The name of the site.

Source:

• Site.js, line 343

Type:

• String

pasvIP :String

Description:

• [FTP/FTPS settings] - In passive (PASV) mode transfers, the server listens on a random port between the minimum and the maximum port numbers specified, waiting for a connection from the client to this port.

  The server sends the client a reply to the PASV command that provides the IP address to connect to and the port number.

  This setting allows a hard-coded IP address to be set. If not set, the IP address of the interface that the server is listening on is provided.

  This setting is required in cases where the IP address of the server is not reachable by clients. For example, the client may need to connect to another IP address that is accessible externally, and a NAT device may direct the connection to the server.

  Related properties: redirectPassiveIPSecureOnly, pasvPortMax, pasvPortMin

Source:

• Site.js, line 363

Type:

• String

pasvPortMax :Number

Description:

• [FTP/FTPS settings] - This is the maximum port number used in passive (PASV) mode. In PASV mode transfers, the server listens on a random port between the minimum and the maximum port numbers specified, waiting for a connection from the client to this port.

  Related properties: pasvIP, redirectPassiveIPSecureOnly, pasvPortMin

Source:

• Site.js, line 496

Type:

• Number

pasvPortMin :Number

Description:

• [FTP/FTPS settings] - This is the minimum port number used in passive (PASV) mode. In PASV mode transfers, the server listens on a random port between the minimum and the maximum port numbers specified, waiting for a connection from the client to this port.

  Related properties: pasvIP, redirectPassiveIPSecureOnly, pasvPortMin

Source:

• Site.js, line 508

Type:

• Number

portFTP :Number

Description:

• [FTP/FTPS settings] - Port that is used for FTP and FTPS in explicit mode. The standard port number for FTP and explicit FTPS is port 21.

Source:

• Site.js, line 516

Type:

• Number

portFTPSImplicit :Number

Description:

• [FTP/FTPS settings] - Port that is used for FTPS in implicit mode. The standard port number for implicit FTPS is port 990.

Source:

• Site.js, line 523

Type:

• Number

portHTTP :Number

Description:

• [HTTP/HTTPS settings] - Port that is used for HTTP. The standard port number for HTTP is port 80.

Source:

• Site.js, line 530

Type:

• Number

portHTTPS :Number

Description:

• [HTTP/HTTPS settings] - Port that is used for HTTPS. The standard port number for HTTP is port 443.

Source:

• Site.js, line 537

Type:

• Number

portSFTP :Number

Description:

• [SFTP/SCP settings] - Port that is used for SFTP, SCP and SSH. The standard port number is port 22. All of these protocols use the same port number.

Source:

• Site.js, line 545

Type:

• Number

readOnly :Boolean

Description:

• [File-system settings] - Enabling this setting will make the site read-only meaning that connected users are unable to make any changes to the site (e.g. upload, delete, rename). This setting overrides file-system permissions.

  This setting is not enabled by default.

Source:

• Site.js, line 373

Type:

• Boolean

redirectPassiveIPSecureOnly :Boolean

Description:

• [FTP/FTPS settings] - In passive mode transfers, some routers don't cope with a hard-coded external IP address as set in External IP address - they expect to see the local LAN IP address in the PASV reply, and they replace this local address with the external IP address themselves. If the local LAN IP address is not found, some routers will abruptly terminate the connection. The solution in these situations is to only supply the hard-coded external IP address for encrypted (i.e. FTPS) connections, which the router can't inspect (and hence can't know what IP address is in the PASV reply). To do this, set this property to true other than false (which is the default).

  Related properties: pasvIP, pasvPortMax, pasvPortMin

Source:

• Site.js, line 188

Type:

• Boolean

scpEnabled :Boolean

Description:

• [SFTP/SCP settings] - Is the SCP protocol enabled for this site?

  This option is enabled by default.

Source:

• Site.js, line 197

Type:

• Boolean

serverMapping :Array.<ServerMapping>

Description:

• An array of ServerMapping objects represents a list of CompleteFTP servers on which this site is enabled/disabled.

Source:

• Site.js, line 759

Type:

• Array.<ServerMapping>

sftpEnabled :Boolean

Description:

• [SFTP/SCP settings] - Is the SFTP protocol is enabled for this site?

  This option is enabled by default.

Source:

• Site.js, line 206

Type:

• Boolean

sharingEnabled :Boolean

Description:

• [File-sharing setting] - Is file-sharing enabled for this site?

  This option is enabled by default.

Source:

• Site.js, line 215

Type:

• Boolean

showHiddenFiles :Boolean

Description:

• [File-system settings] - Files are considered hidden if either (1) the Windows Hidden property is set for that file, or (2) the name of the file starts with a dot ('.').

  If this option is enabled then hidden files will be shown in listings. Otherwise, they will not be shown in listings (which is the default).

  IMPORTANT! The fact that a file is hidden from listing does NOT imply that it cannot be accessed (i.e. read from, written to, renamed or deleted). To control accessibility please use the permissions for each specific folder.

Source:

• Site.js, line 230

Type:

• Boolean

sshAuthMethods :Array.<String>

Description:

• [SFTP/SCP settings] - Methods of user-authentication (listed below) that the server accepts. Note that these methods can also be specified at the user level (see User.sshAuthMethods). When a user logs in, only the authentication methods specified at both levels are available. For example, if the site permits password only, and the user permits password and publickey, then only password will be available.

  • 'Password' - only a password is required. A password must be set for each user using User.password
  • 'PublicKey' - public key cryptography is used to authenticate the user. For every user the server must have a public key that matches the client's private key. Note that this method of authentication does not work for Windows users, since a password is required by Windows to log the user in. Thus Password or PublicKeyAndPassword should be enabled if Windows users are to be allowed to connect.
  • 'PublicKeyAndPassword' - both password and public-key authentication are used.

  In order to select all authentication methods (which is already the default), set this property to the array, ['All'].

Source:

• Site.js, line 564

Type:

• Array.<String>

sshCipher :Array.<String>

Description:

• [SFTP/SCP settings] - Controls what ciphers (listed below) are available to SSH for encrypting data. The default setting of All should generally be used unless some ciphers are required to be disabled.

  • 'TripleDES'
  • 'Blowfish'
  • 'AES128'
  • 'AES192'
  • 'AES256'
  • 'AES_CTR_128'
  • 'AES_CTR_192'
  • 'AES_CTR_256'

  In order to select all ciphers (which is already the default), set this property to the array, ['All'].

Source:

• Site.js, line 582

Type:

• Array.<String>

sshCompression :Array.<String>

Description:

• [SFTP/SCP settings] - Permits the compression algorithms (listed below) used in SSH to be selected.

  • 'None'
  • 'Zlib'

  For example, if 'Zlib' compression is to be forced, then 'None' would need to be unselected.

  In order to select all compression algorithms (which is already the default), set this property to the array, ['All'].

Source:

• Site.js, line 595

Type:

• Array.<String>

sshForwardingEnabled :Boolean

Description:

• [SFTP/SCP settings] - If this setting is enabled, local SSH TCP/IP forwarding will be enabled for the site. This means local (to a client machine) SSH tunnels can be established between a client and CompleteFTP, and data will be forwarded on to the host specified when the tunnel was set up. On the client side, the tunnel must be set up by an SSH utility such as PuTTY.

  This option is not enabled by default.

Source:

• Site.js, line 242

Type:

• Boolean

sshKeyAlgorithm :Array.<String>

Description:

• [SFTP/SCP settings] - Controls what public key algorithms (listed below) are supported by the server. For example, RSA public keys can be forced by disabling DSA.

  • 'DSA'
  • 'RSA'

  In order to select all public key algorithms (which is already the default), set this property to the array, ['All'].

Source:

• Site.js, line 606

Type:

• Array.<String>

sshKeyExchange :Array.<String>

Description:

• [SFTP/SCP settings] - Controls what key exchange methods (listed below) are supported by the server. It is rare that the defaults (i.e. all is selected) should be changed. It is possible that an administrator may want to disable weaker key exchange methods.

  • 'DiffieHellmanGroup1Sha1'
  • 'DiffieHellmanGroup14Sha1'
  • 'DiffieHellmanGroupExchangeSha1'
  • 'DiffieHellmanGroupExchangeSha256'

  In order to select all key exchange methods (which is already the default), set this property to the array, ['All'].

Source:

• Site.js, line 621

Type:

• Array.<String>

sshKeyPairDSA :KeyPair

Description:

• [SFTP/SCP settings] - A KeyPair object that allows the RSA server key to be modified for this site.

Source:

• Site.js, line 766

Type:

• KeyPair

sshKeyPairRSA :KeyPair

Description:

• [SFTP/SCP settings] - A KeyPair object that allows the DSA server key to be modified for this site.

Source:

• Site.js, line 773

Type:

• KeyPair

sshMAC :Array.<String>

Description:

• [SFTP/SCP settings] - Permits the MAC algorithms (listed below) used in SSH to be selected. The default setting of All should generally be used unless some MACs are required to be disabled.

  • 'HMACSHA1'
  • 'HMACMD5'
  • 'HMAC_SHA1_96'
  • 'HMAC_MD5_96'
  • 'HMAC_SHA2_256'
  • 'HMAC_SHA2_512'

  In order to select all MAC algorithms (which is already the default), set this property to the array, ['All'].

Source:

• Site.js, line 637

Type:

• Array.<String>

sshTerminalEnabled :Boolean

Description:

• [SFTP/SCP settings] - If this setting is enabled, users may (if permitted) log into the server using an SSH terminal.

  This option is not enabled by default.

Source:

• Site.js, line 251

Type:

• Boolean

sslCertificate :SSLCertificate

Description:

• [FTPS & HTTPS settings] - The server's SSL certificate set for this site. Note that this setting is shared between FTPS and HTTPS, both of which use SSL/TLS.

Source:

• Site.js, line 781

Type:

• SSLCertificate

sslCipherSuites :Array.<String>

Description:

• [FTPS & HTTPS settings] - This setting controls the cipher suites that can be used. All available cipher suites are:

  • 'RSA_AES_256_SHA'
  • 'RSA_AES_128_SHA'
  • 'RSA_AES_128_SHA256'
  • 'RSA_AES_256_SHA256'
  • 'RSA_3DES_168_SHA'
  • 'DHE_RSA_3DES_SHA'
  • 'DHE_RSA_AES_128_SHA'
  • 'DHE_RSA_AES_256_SHA'
  • 'DHE_RSA_AES_128_SHA256'
  • 'DHE_RSA_AES_256_SHA256'
  • 'DHE_RSA_DES_SHA'
  • 'RSA_DES_40_SHA'
  • 'RSA_DES_56_SHA'
  • 'RSA_RC2_40_MD5'
  • 'RSA_RC4_128_SHA'
  • 'RSA_RC4_128_MD5'
  • 'RSA_RC4_40_MD5'
  • 'ECDHE_RSA_3DES_SHA'
  • 'ECDHE_RSA_AES_128_SHA'
  • 'ECDHE_RSA_AES_256_SHA'

  Generally, the default (listed below) is appropriate unless there are special requirements for a particular algorithm.

  • 'RSA_3DES_168_SHA'
  • 'RSA_AES_128_SHA'
  • 'RSA_AES_256_SHA'
  • 'RSA_AES_128_SHA256'
  • 'RSA_AES_256_SHA256'
  • 'DHE_RSA_3DES_SHA'
  • 'ECDHE_RSA_3DES_SHA'
  • 'DHE_RSA_AES_128_SHA'
  • 'DHE_RSA_AES_256_SHA'
  • 'DHE_RSA_AES_128_SHA256'
  • 'DHE_RSA_AES_256_SHA256'
  • 'ECDHE_RSA_AES_128_SHA'
  • 'ECDHE_RSA_AES_256_SHA'

  In order to select all cipher suites, set this property to the array, ['All'].

  Note that this setting is shared between FTPS and HTTPS, both of which use SSL/TLS.

Source:

• Site.js, line 683

Type:

• Array.<String>

timeoutHTTP :Number

Description:

• [Limits and timeouts settings] - The maximum time in milliseconds before HTTP sessions expire. The default is 1,800,000 milliseconds (30 minutes).

  If the timeout is set to zero, sessions do not expire.

Source:

• Site.js, line 736

Type:

• Number

timeoutIdle :Number

Description:

• [Limits and timeouts settings] - The maximum time in milliseconds that a connection is permitted to be idle, i.e. if no commands are sent from the client. The default is 300,000 milliseconds (5 minutes).

  If the timeout is set to zero, the timeout is infinite, i.e. the connection does not time out.

Source:

• Site.js, line 694

Type:

• Number

timeoutLogin :Number

Description:

• [Limits and timeouts settings] - The maximum time in milliseconds permitted for a login attempt. If a connection is made and login is not completed within this period, the connection is closed. The default is 60,000 milliseconds (1 minute).

  If the timeout is set to zero, the timeout is infinite, i.e. the connection does not time out.

Source:

• Site.js, line 704

Type:

• Number

timeoutPassiveWait :Number

Description:

• [Limits and timeouts settings] - In passive mode, the server listens on a socket, waiting for the client to make a connection. The client can connect before actually sending the next command (LIST, NLST, RETR or STOR), and the server must wait for this next command before it can do anything with the client connection.

  By default, the timeout is set to 60,000 milliseconds (1 minute). If the timeout is set to zero, the timeout is infinite, i.e. the connection does not time out.

Source:

• Site.js, line 716

Type:

• Number

timeoutStalled :Number

Description:

• [Limits and timeouts settings] - The maximum time in milliseconds that the underlying sockets wait for while performing read operations. The default is 60,000 milliseconds (1 minute).

  If the timeout is set to zero, the timeout is infinite, i.e. read operations do not time out.

Source:

• Site.js, line 726

Type:

• Number

welcomeMessage :String

Description:

• [Messages settings] - The text that is displayed (i.e. sent to the client) during a login attempt. In SFTP this is the banner message, and is often not displayed by SFTP clients.

  Related properties: hideProductVersion

Source:

• Site.js, line 383

Type:

• String