Setting Up Users

The Aspera server uses your system accounts to authenticate connections from remote clients. The system users must be added and configured as Aspera transfer users before remote clients can run FASP transfers with the server. When creating transfer users, you may also specify user-specific settings, such as transfer bandwidth, docroot, and file handling.

Follow the steps below to configure a system user account as an Aspera transfer user.

Note: User names are case sensitive on Windows as of version 3.0.0.
  1. Launch the Aspera server as Administrator.
    Log into your computer with your Administrator account. Click Start menu > All Programs > Aspera > Point-to-Point . Right click Point-to-Point and click Run as administrator.
  2. Click Configuration to open the configuration settings window.
    Click the Configuration.
  3. Add a system user to your Aspera server.
    In Server Configuration, select the Users tab and click the Add user button to add a new user. Add the test user.

    In the Add User dialog, enter the username.

    Note: Usernames cannot contain the "@" symbol, except when using the user@domain format. For additional information, see Product Limitations.
  4. Enter the domain and set the login requirement.
    The domain is optional, except for domain users who will transfer with this server through Aspera web applications such as Shares or Faspex. Click OK.

    You can require that users log into their accounts using the DOMAIN\username format. This is recommended by Aspera and required for domain users who will transfer with this server through Aspera web applications such as Shares or Faspex .

    Add the test user login requirement.

    To set this requirement after a user has been created, click the Options button under the Users tab in the Server Configuration window. Click the Convert existing users button to set the requirement for existing domain accounts.

  5. Set the user's docroot.
    You can limit a user's access to a given directory using the document root (docroot). The docroot can be set for individual users and globally.

    Individual user docroot: In the user's Docroot tab (Configuration > Users >username > Docroot), select the Override box for Absolute Path and enter or select an existing path as the user's docroot -- for example, C:\sandbox\aspera_user_1 . Make sure that at least the Read Allowed and Browse Allowed are set to true. When finished, click OK or Apply.

    Note: When you configure a docroot for a Windows system user, the user is automatically assigned to use aspshell, which permits only the following operations from the command line:
    • Running Aspera uploads and downloads to or from this computer.
    • Establishing connections in the application, and browsing, creating, deleting, renaming, or listing contents.

    Set up the docroot.

    Global docroot: To set up a global docroot, in the Server Configuration window, click the Global tab. In the Docroot tab, select the Override box and enter the docroot into the Absolute Path field. This value will be duplicated in all user settings.

    If there is a pattern in the docroot of each user, for example, C:\sandbox\username, you can use a substitutional string. This allows you to assign an independent docroot to each user without setting it individually for each user.

    Substitutional String Definition Example
    $(name) system user's name C:\sandbox\$(name)
    $(DOMAIN) domain user's domain name C:\sandbox\$(DOMAIN)\$(name)
    $(home) system user's home directory $(home)\Documents
    Use the substitutional string for the docroot.
  6. Configure other settings for the specific user.
    These settings are located in the Docroot, Authorization, Bandwidth, Network, File Handling and Precedence tabs. Follow the hyperlinks in the table below for additional information.
    Category Description
    Document Root The document root settings.
    Authorization Connection permissions, token key, and encryption requirements.
    Bandwidth Incoming and outgoing transfer bandwidth and policy settings.
    Network Network IP, port, and socket buffer settings.
    File Handling File handling settings, such as file block size, overwrite rules, and exclude pattern.