Customizing New User Account Form

You can customize the New User Account form admins must fill out to create new accounts by marking certain fields required. For example, if you mark the option Password expires as required, that field becomes required when creating a user.

The following fields can be marked as required:
  • Password expires
  • Account expires
  • Allowed IP addresses for login
  • Allowed IP addresses for download
  • Allowed IP addresses for upload
Note: This feature involves modifying the faspex.yml configuration file. Modifying faspex.yml is for advanced administrative users only.
The faspex.yml file is located in the following directory:
OS Version Location
Windows 32-bit C:\Program Files\Aspera\Faspex\config\faspex.yml
Windows 64-bit C:\Program Files (x86)\Aspera\Faspex\config\faspex.yml
Important: Be sure to back up faspex.yml before modifying.
  1. Stop Faspex.

    Execute the command to stop Faspex:

    > asctl faspex:stop
  2. Open faspex.yml with a text editor.

    Locate faspex.yml in the following location:

    OS Version Path
    32-bit Windows C:\Program Files\Aspera\Faspex\config\Faspex.yml
    64-bit Windows C:\Program Files (x86)\Aspera\Faspex\config\Faspex.yml

    Before editing faspex.yml, create a backup. Open it with a text editor:

  3. Write the required-field parameters into your faspex.yml file.

    Write the following parameters into the file. When a required field is specified, the option is checked and grayed-out; When a required field with default value is specified, a default value is presented in the option.

    Parameter Description
    RequireUserPasswordExpires: yes Make "Password expires" required. A value is required.
    RequireUserAccountExpires: yes Make "Account expires" required. A value is required.
    RequireUserDescription: yes Make "description" required.
    RequireUserDescriptionWithDefault: "Default_value" Make "description" required, and insert default value.
    RequireUserAllowedIpAddressesForLogin: yes Make "Allowed IP addresses for login" required.
    RequireUserAllowedIpAddressesForLoginWithDefault: "Default_value" Make "Allowed IP addresses for login" required, and insert default value.
    RequireUserAllowedIpAddressesForDownload: yes Make "Allowed IP addresses for download" required.
    RequireUserAllowedIpAddressesForDownloadWithDefault: "Default_value" Make "Allowed IP addresses for download" required, and insert default value.
    RequireUserAllowedIpAddressesForUpload: yes Make "Allowed IP addresses for upload" required.
    RequireUserAllowedIpAddressesForUploadWithDefault: "Default_value" Make "Allowed IP addresses for upload" required, and insert default value.

    For example, to make "Account expires" required, and "Allowed IP addresses for download" required with default value "10.0.*", add the following lines in Faspex.yml:

     ...
     RequireUserAccountExpires: yes
     RequireUserAllowedIpAddressesForDownloadWithDefault: "10.0.*"
  4. Start Faspex.
    Execute the command to start Faspex with the new setting:
    > asctl faspex:start

To verify the modified fields are now required, log into Faspex with an admin account and go to Accounts > New User. Red asterisks appear near the fields that have been marked as required. Trying to create a user without specifying values for these field result in an error message to that effect.