Configuring for Faspex

If you plan to use the Aspera CLI to transfer packages through Faspex, you must configure the Aspera CLI after installing it.

Before You Begin

The instructions in this section assume that you have
  • A Faspex server, installed and configured.
  • The Aspera CLI, installed on a computer.

Configuration Steps

  1. Edit the CLI config file.
    1. Locate the .aspera_cli_conf configuration file:
      installation_directory\cli\bin\.aspera_cli_conf
    2. In a text editor, edit the Faspex section of the .aspera_cli_conf file to set the following:
      name The name of your Faspex server.
      sources > id The ID number of your Faspex server.
      sources > name The (human-readable) name of your Faspex server.
      sources > scheme HTTPS, for example.
      sources > host The URL or IP address of your Faspex server.
      sources > port The port number that will be used for transfers.
      sources > username The username for your account on the Faspex server.
      sources > password The password for that account on the Faspex server
      sources > base_dir The base directory for transfers.
    3. Save the .aspera_cli_conf file.

Credentials in Your Configuration File

The username and password credentials that you set in the .aspera_cli_conf file should be the same as the credentials for the Node API user on your Faspex server (not host system credentials).

Defining Multiple Servers

You can define multiple Faspex servers in the .aspera_cli_conf file, and multiple sources for each server. Then at the command line, you can specify which one to use, with the id or name value that you defined in the configuration file.