SFTP Category

The SFTP options category allows you to enable and configure the SFTP subsystem.

SFTP Root List

This list displays the available SFTP root folder mappings. Each mapping consists of an SFTP root path, its corresponding alias, and a User/Group list (see below). Users will not be able to access folders or files that do not reside in a SFTP root to which they have access. Users that are granted access to the <Unrestricted> root can access any file that their Windows permissions allow them to access.

An SFTP Root that has an invalid path (one that doesn't exist, for example) will not be accessible to any users.

Upon connecting, the user will be placed in the first available SFTP root folder unless the Load the user's environment option (see below) is selected. If there are no SFTP roots available to the user, the user will be disconnected.

Use single virtual root

Checking this option will place all defined SFTP roots under a single virtual root.

User/Group List

This list displays the users and/or groups that have been explicitly allowed or denied access to the root selected in the SFTP Root list. It also displays their access status. A user or group that is denied access will not be able to access the system even if they are part of a group that has been allowed access. An SFTP root with an empty User/Group list will not be available to any users. Users will not be allowed to access any folder above the specified folder.

Load the user's environment

Checking this option adds VSHELL_FILE_HOME and VSHELL_HOME environment variables among others to your choice of home folders.

Note: Checking this option will increase logon time because each user profile must be loaded in order to read the user's environment variables.

If this option is selected, VShell determines the user's "Home" folder (the folder in which the user is initially placed upon connecting) based on the following criteria (in the following order, first match succeeds):

    VSHELL_FILE_HOME user environment variable, if it exists and is a valid path.

    VSHELL_HOME user environment variable if the VSHELL_SFTP_HOME environment variable does not exist or its value is not a valid path.

    The user's "My Documents" folder, if it exists.

    If the above environment variables do not exist or the values are not valid paths, VShell will place the user in the root of the system drive.

After determining the "Home" folder, if the "Home" folder is not accessible to the user, the user will be placed in the first available SFTP root folder. If there are no SFTP roots available to the user, the user will be disconnected.

Add and Edit Buttons

The Add and Edit buttons open the SFTP Root Path dialog where you can add or edit SFTP root paths and configure the users and groups assigned to them. Changes made to the SFTP root configuration will not take effect until you press either the Apply or OK button.