Configuring for Files

If you plan to use the Aspera CLI to transfer packages to a Files workspace, you must configure both.

Configuration Steps

The following steps assume that
  • You have a working Files instance and at least one workspace.
  • You have the relevant JWT private/public key pair.
  • You have installed the Aspera CLI.
To configure Files and the Aspera CLI to work together, do the following:
  1. In Files, set up JWT authentication for the Aspera CLI.

    Use the instructions in the Files Help Center at https://testeng.qa.asperafiles.com/helpcenter/admin/organization/registering-an-api-client. In this process, you are registering the Aspera CLI as a client that will be allowed to use the Files API without going through a web browser.

    Note: This registration must be performed by a Files admin. The admin must have the JWT public key. The output of the registration process is the client ID and secret, which are used in a later step.
  2. In Files, add your JWT public key.

    Use the instructions in the Files Help Center at https://aspera.asperafiles.com/helpcenter/using-files/basic/adding-your-public-key.

  3. In the Aspera CLI installation, add your private key.

    The file must be located in installation_directory\cli\etc.

  4. In the Aspera CLI installation, edit the configuration file.
    1. Locate the .aspera_cli_conf configuration file:
      ~/.aspera/cli/bin/.aspera_cli_conf
    2. In a text editor, edit the Files section of the .aspera_cli_conf file to set the following:
      • The client ID (client_ID) and secret (client_secret) that you obtained in Step 1.
      • The filename of the private key (private_key_file_name). The default value is private.pem.
      • The organization name (name) and hostname (host) of the Files server.
    3. Save the .aspera_cli_conf file.

Configuration File Syntax

The Aspera CLI package installs a .aspera_cli_conf file with sample configurations that you can use to see the correct syntax for this file.

Defining Multiple Servers

You can define multiple 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 name value that you defined in the configuration file.