Advanced Settings

Advanced options for SFTP Drive are stored in the Windows registry in HKEY_LOCAL_MACHINE\SOFTWARE\nsoftware\SFTPDrive\3. This registry key holds settings that are available for SFTP Drive globally. Sub-keys at this path hold settings for individual drives, and trusted SSH host keys.

The following keys hold configuration information:


Registry Key	Applicable Settings
`HKEY_LOCAL_MACHINE\SOFTWARE\nsoftware\SFTPDrive\3`	Global settings for the application.
`HKEY_LOCAL_MACHINE\SOFTWARE\nsoftware\SFTPDrive\3\Drives`	Drives hold drive specific settings.
`HKEY_LOCAL_MACHINE\SOFTWARE\nsoftware\SFTPDrive\3\TrustedSSHHostKeys`	Trusted SSH Host Keys stores trusted host keys.

The following values can be configured within the root HKEY_LOCAL_MACHINE\SOFTWARE\nsoftware\SFTPDrive\3 registry key:


Name	Type	Description
DeleteLogDays	DWORD	Specifies the number of days that log files will remain before being deleted. Only applies if `RotateLogDays` is greater than 0. If set to 0, old logs will not be deleted.
ForceFileClose	DWORD	Specifies whether to force the closure and subsequent update of the encrypted file on disk after the last handle to the file is closed. In general the application will update the header of the encrypted file on disk when the file is closed. In some cases the system may not close the file immediately after the last handle is closed which results in the file on disk not being updated in a timely manner. This setting forces the closure of the file after the last handle is released. Possible values are: 0 - Not Enabled 1 - Enabled (default)
LogFile	String	Contains the path to the log file.
LogMode	DWORD	Determines the level of logging: 0 - Off. Nothing will be logged. 1 - Error. Only errors in SFTP Drive's operation will be logged. 2 - Warning. Additional warning information will be logged. 3 - Info. General information about the status of the connection will be logged. 4 - Verbose. Logs additional information about the connection and detailed protocol information. 5 - Debug. Logs detailed debug information. 6 - Debug2. Additional debug information. CAUTION: This generates a very large amount of data.
LogPort	DWORD	The SysLog port that will be used to communicate between the service and the UI when SFTP Drive is running as a service.
LogToFile	DWORD	Determines whether or not the log will be written to a file. The file itself is specified by `LogFile`. 0 - The log will only be written to the Log window on the Service tab. (default) 1 - The log will also be saved to a file.
MaskSensitive	DWORD	Determines whether or not passwords will be masked in the log. 0 - Passwords will be visible in the log. 1 - Passwords will be replaced with '*' characters in the log. (default)
MaxLogLines	DWORD	Determines the maximum number of lines that will be stored in the Log window in the Service tab.
MountTimeout	DWORD	Determines how long (in seconds) SFTP Drive will wait for Windows to mount a drive without reporting an error. The default is 20 seconds when this value is not present in the registry.
PasswordEncryptionMethod	String	Determines how passwords are encrypted for storage. The default value is `Auto`. Possible values are: `Auto` (default) - Microsoft DPAPI is used to encrypt passwords. When running the application as a user (not as a Windows service) the passwords are encrypted and can only be decrypted by the current user. When running as a Windows service the passwords are encrypted for the machine and can be decrypted by any user on the machine. When running as a Windows service the user application and the service run under different accounts and must both be able to decrypt the values stored in the registry. Additional values are reserved for future use.
PromptForRegPermissions	DWORD	Determines if SFTP Drive will ask for registry permissions if it does not have them when it tries to write to the registry. 0 - SFTP Drive will not ask for registry permissions, instead bringing up a UAC dialog for one-time access. 1 - SFTP Drive will ask to be granted registry permissions. If granted, UAC access will not be required in the future. (default)
RotateLogDays	DWORD	Specifies how many days SFTP Drive will use a log file before rotating to a new log file. If set to 0, the log file will never rotate.
RunAsService	DWORD	Determines whether or not SFTP Drive will run as a service.
ShowDotFiles	DWORD	Determines whether files that start with a dot or period (.) are returned in a directory listing. 0 - Dot files are not returned, so they are not displayed in explorer. 1 - Dot files are returned in the directory listing (default).
HideDotFiles	DWORD	Determines whether files that start with a dot or period (.) are marked as hidden when returned in a directory listing. 0 - Do not hide dot files (default). 1 - Any dot files will be marked with the hidden attribute.
IgnoredDirs	String	Specifies a comma-separated list of folders should be ignored by the virtual drive. Each folder included on the list cannot be created on the virtual drive and will not be returned in directory listings. Please specify the folder relative to the root of the drive. Note: Use with caution. When the system asks us to create these folders we will respond with `SYSERR_CANNOT_MAKE`. Applications or system components that rely on these filesystem operations may start to behave unexpectedly. "" - Nothing is ignored (default). "\$RECYCLE.BIN" - Prevents the system from creating a recycle bin folder.
IgnoredFiles	String	Specifies a comma-separated list of files to ignore requests for. Windows may make frequent, informational requests for files that it needs such as `desktop.ini`. If the request being made by the operating system is for one of the files in this list, the request will not be made to the S3 provider. For each file on this list, we will service the system's request without performing the operation against remote storage. We respond by telling the system the file does not exist for simplicity. "autorun.inf,bootmgr,bootnxt,hiberfil.sys,pagefile.sys,desktop.ini,thumbs.db" (default).
UseMetadataCache	DWORD	Specifies whether SFTP Drive will use caching for file metadata and directory enumeration entries. Disabling will cause SFTP Drive to re-download this information when it is requested by Windows and will slow performance. 0 - No cache 1 - Use caching (default)
LogPackets	DWORD	Determines whether or not the contents of SFTP Packets will be written to the log. Note that the additional output from this mode will slow operation considerably, so it is recommended that it only be enabled when necessary to diagnose an issue. 0 - SFTP packet contents will not be logged (default) 1 - SFTP packet contents will be written to the log.
UseCompression	DWORD	Determines whether or not the SSH connection will use zlib compression. 0 - No compression (default) 1 - Use zlib compression
KeepAliveInterval	DWORD	Determines how often a keep alive packet is sent to the server, in seconds. If set to 0, no keep alive packets will be sent.
LocalHost	String	Specifies the local IP address of the network interface to use when connecting. This settings is typically only useful in machines with multiple network interfaces.
ProxyChecked	DWORD	Specifies whether or not the proxy settings are enabled.
ProxyHost	String	Specifies the host that SFTP Drive will use to connect to the proxy.
ProxyPassword	String	Specifies the password that SFTP Drive will use to connect to the proxy.
ProxyPort	DWORD	Specifies the port that SFTP Drive will use to connect to the proxy.
ProxyType	DWORD	Specifies the type of proxy that SFTP Drive will connect to. 0 - None (default) 1 - Tunnel 2 - SOCKS4 3 - SOCKS5
ProxyUsername	String	Specifies the username that SFTP Drive will use to connect to the proxy.
ReconnectAttempts	DWORD	Specifies the number of times SFTP Drive will attempt to reconnect if the connection to the server is lost.
ReconnectInterval	DWORD	Specifies the time (in seconds) between attempting another reconnection to the server. Default is 5 seconds.
Timeout	DWORD	Determines how many seconds SFTP Drive will wait for a response from the server before ending the connection.

SFTP Drive V3

Advanced Settings