Configuring Cargo for Faspex

Cargo uses a configuration file to store the account information for your transfer servers and settings for the way that packages are going to be downloaded. Before Cargo can function correctly, you must specify these elements in the .conf file.

  1. If Cargo is running, stop the daemon.
  2. Find the sample configuration file in the following path.

    /Library/Aspera/Cargo/etc/faspex.sample.conf

    Note: Make sure that your configuration file is valid JSON. For example, if your path uses backslashes, use /.
  3. In a text editor, modify the sample configuration file. See the following table for required fields.
    Note: If your environment includes different types of servers, you can create a single configuration file that lists the information for all of them.
  4. Save your edited configuration file.

    You can change the file name of the sample file. Your new file name must end in .conf.

  5. Import the file into Cargo.
    $ sudo /Library/Aspera/Cargo/sbin/cargo -f path-to-config-file
  6. For security, if you have set the <password_cleartext> or <passphrase_cleartext> fields, delete the configuration file after you have imported it, to avoid leaving the password in unencrypted form.

Sample configuration file

A sample configuration file is shown (and is included in the installation package). Your settings might differ from the examples shown. At a minimum, change the required entries to your system, and import the file. For instructions, see the previous steps.

The text of the faspex.sample.conf file:

{
    "conf": {
        "accounts": [
            {
                "authentication_type": "BASIC",
                "sso_host_type": 1
                "host": "https://sample.com",
                "name": "Sample Faspex",
                "user": "username",
                "password_cleartext": "password",
                "packages": {
                    "check_interval_seconds": 900,
                    "download_dir": "/path/to/automatically/download/packages/to/",
                    "name": "Sample Faspex Inbox",
                    "passphrase_cleartext": "",
                    "passphrase_enabled": false,
                    "separate_package_folders": true,
                    "skip_owner_packages": false,
                    "version": 2
                }
            }
        ],
        "version": 1
    }
}

Conf file fields and values

Field Required/Optional Description Values
authentication_type Required Cargo's authentication type that is used with this transfer server. Do not modify the value in this field. BASIC
host Required The Faspex server hostname or IP address.  
name Required A human-readable name for your Faspex server, for differentiation of multiple accounts.  
user Required Your Faspex username (usually an email address).  
password_cleartext Required The password for your Faspex account. For security, the value you enter in the <password_cleartext> field is stored in an encrypted form when you import the configuration file.
Important: If you use the <password_cleartext> field, be sure to delete the configuration file after you have imported it, to avoid leaving the password in unencrypted form.
  
packages fields:      
auto_start Optional Sets whether Cargo must automatically start checking for packages when it is started. Cargo sets this value to true.
check_interval_seconds Optional The time, in seconds, to elapse between checking for new packages. Valid values are 60, 300, 900, 1800, and 3600.

The default value is 900.
download_dir Required The absolute path to the directory that is used to store downloaded packages.  
passphrase_cleartext Optional; required for automatic package decryption. The passphrase that Cargo must use for automatic decryption of packages upon download.

If there is a passphrase mismatch, the file is left encrypted, but is downloaded successfully.

For security, the value you enter in the <passphrase_cleartext> field is stored in an encrypted form when you import the configuration file.
Important: If you use the <passphrase_cleartext> field, be sure to delete the configuration file after you have imported it, to avoid leaving the password in unencrypted form.
  
passphrase_enabled Optional Set to true if you want Cargo to use a passphrase to decrypt packages.

Set the passphrase itself in the <passphrase_cleartext> field.

 The default value is false.
separate_package_folders Optional Set to true if you want packages with the same title to be downloaded to unique folders. The default value is true.
skip_owner_packages Optional Set to true if Cargo must skip packages that you sent to yourself. The default value is false.
version Required Cargo-internal data. Do not modify the value in this field.  
sso_host_type Required. Attribute to differentiate the types of host/server. Do not modify the value in this field.