SFTP Gateway Support

3.0

Add and Configure Users Using UI

Before you continue, make sure to sign in.

Once you login, you will see a list of all users (which will initially be empty). In the upper right corner click on the Add User button (Fig-1). Create user button
Fig-1

Configure New User

Create user form
Fig-2

Refer to Fig-2:

  1. Username is required and must be unique.

  2. Notes can be used to add details for a specific user.

  3. Home Directory is used to specify where the user will the user will land when they connect to the SFTP Gateway Server.

    • Create Username Home Directory will create a folder with the user's name in the users folder
    • Select Home Directory will open the Select Home Directory modal (Fig-3)

    Select Home Directory Fig-3

    1. Selected Folder shows the folder that you currently have selected.
    2. Folder Selector allows you to navigate the available folders and add to the selected folder.
    3. Folder Search allows you to search for a specific folder.
    4. Permissions allows you to set the user's permissions to the selected folder.

  4. SFTP SSH Keys is used to set the public keys the user can use for SFTP login.
    The Add SSH Key button will open the SSH key modal(Fig-4)

    SSH Key Modal Fig-4

    1. Key Name is used to identify the key on the key list.
    2. Enabled can be used to quickly toggle SFTP access with this key.
    3. SSH Public Key text area where you can paste in the plain text ssh public key.
    4. Upload Public Key allows you to upload a public key file. If the key name field is empty the key file name will be used.
    5. Generate Key can be used to generate an SSH key pair. The public key portion will be populated in the Public key text area, while the private key portion will be automatically downloaded for you to send to the user. If the key name field is empty an auto-generated name will be populated.
    6. Bit Selector can be used to select the size of the key you wish to generate. larger keys are more secure but take longer to generate.

  5. Advanced Options expands the advanced options section.

  6. SFTP Password is used to set a password the user can use for SFTP login.

  7. IP Address Allowlist used to restrict SFTP access for this user to specific IP addresses. Add IP addresses in the form of a CIDR range which just includes /32 to the end of the IP address.

Video Reference

← PreviousNext →