Configuring the Cargo Daemon

Cargo includes a headless daemon, CargoD. To configure CargoD, open the following configuration file in a text editor:

/Library/Aspera/CargoD/etc/asperacargo.conf

Aspera has provided a sample asperacargo.conf file below (which is also built into the installation package). Your settings may differ from the example shown. At a minimum, change the required entries, as appropriate to your system.

Note: You must use XML-appropriate symbols when editing the configuration file. For example, & instead of &.
Important: Enter your password in the <password> field in plain text. After you start the CargoD service for the first time, the password will be obfuscated so that an observer cannot deduce the password by reading the file.
<?xml version='1.0' encoding='UTF-8'?>
<conf version="1">

<accounts>
    
    <!-- Add one or more accounts here. -->
    <account>

	    <!-- Required. -->	    
	    <user>faspexuser1</user>

	    <!-- Required. -->
	    <password>p@ssword</password>

	    <!-- Required. eg. https://example.com/aspera/faspex -->	    
	    <host>https://www.mycompany.com/aspera/faspex</host>

	    <!-- Required. This is the location where all the account packages will be downloaded. -->
	    <download_folder>/incoming_packages/</download_folder>

	    <!-- Optional. If specified, Cargo will attempt to decrypt during download. -->
	    <passphrase>p@ssword</passphrase>

      <!--Optional. Cargo stops looking for packages with sequence IDs less than or equal to 
      this number. (default 0)-->            
      <last_sequence_id>0</last_sequence_id>            

      <!--Optional. Cargo will ignore invalid certificates. (default false)-->            
      <ignore_invalid_cert>false</ignore_invalid_cert>

    </account>

</accounts>

<general>

    <!-- Optional. Time, in minutes, to check for new packages. Valid values are 1, 5, 15, 30, 60. (default 15) -->
    <check_interval>5</check_interval>

    <!-- Optional. This is the maximum number of active or failed transfers in the queue.
    If the max is reached, failed transfers will be removed.
    If there are no failed transfers, no new transfers will be added. (default 100) -->
    <max_transfers>50</max_transfers>

    <!-- Location of the cargo database to write to or read from.
    (default $INSTALL_DIR/var ) -->
    <db_dir></db_dir>

</general>

<transfers>

    <!-- Optional. Set to true to download packages to unique folders. (default true) -->
    <separate_folders></separate_folders>

    <!-- Optional. Number of retries for failed transfers. (default 3)-->
    <retry_attempts></retry_attempts>

    <!-- Optional. Interval, in seconds, between retries. (default 30)-->
    <retry_interval></retry_interval>

    <!-- Optional. Specifies verbosity of logging.
    0 - info, 1 - debug, 2 - trace. (default 0) -->
    <log_level></log_level>

</transfers>

<network>

    <http_proxy>
	      <!-- Optional. Set to true to set fallback proxy settings. (default false) -->
	      <enable>false</enable>
	      <username></username>
	      <password></password>
	      <address></address>
	      <port></port>
    </http_proxy>

    <fasp_proxy>
	      <!-- Optional. Set to true to set FASP proxy settings. (default false) -->
	      <enable>false</enable>
	      <username></username>
	      <password></password>

	      <!-- dnat:// or dnats:// for secure FASP proxy. -->
	      <address></address>
	      <port></port>
    </fasp_proxy>

</network>

<bandwidth>

    <!-- Optional. Download bandwidth limit in Mbps. To let server decide, leave empty. -->
    <download_limit></download_limit>

</bandwidth>

</conf>

Setting Description Values
User (Required) Your Faspex user name (that is, your login ID).  
Password (Required) Your Faspex account's password. For security, the <password/> tag is converted to <password_obfuscated/> upon successful parsing of the conf file. Subsequent reads of the conf file will use the obfuscated tag.  
Host (Required) Faspex Server hostname or IP address.  
Download Folder (Required) The directory that will be used to stored downloaded packages.  
Passphrase (Required) Enter your passphrase to automatically decrypt packages upon download. If there is a passphrase mismatch, the file is left encrypted, but downloads successfully. For security, the <passphrase/> tag is converted to <passphrase_obfuscated/> upon successful parsing of the conf file. Subsequent reads of the conf file will use the obfuscated tag.  
Check Interval (Optional) Time elapsed (in minutes) between checking for new packages. Valid values are 1, 5, 15, 30 and 60 minutes, where 15 minutes is the default value.
Max Transfers (Optional) The maximum number of active or failed transfers in the download queue. If the max is reached, failed transfers will be removed. If there are no failed transfers, no new transfers will be added. Default value is 100.
DB Directory (Optional) CargoD's database location. Note that one asperacargod process can only access one database location at a time. You can run multiple, concurrent asperacargod processes by creating a conf file and db directory for each process. Default is $INSTALL_DIR/var
Separate Folders (Optional) Set to true to download packages with the same title to unique folders. Default is true.
Retry Attempts (Optional) Number of retries for failed transfers. Default is 3.
Retry Intervals (Optional) Interval between retries in seconds. Default is 30.
Log Level (Optional) Specifies logging verbosity.
  • 0 - info (default)
  • 1 - debug
  • 2 - trace
HTTP Fallback Proxy (Optional) By setting <enable/> to true, you can modify the proxy configuration for the server handling HTTP fallback. HTTP fallback serves as a secondary transfer method when the Internet connectivity required for Aspera accelerated transfers (i.e., UDP port 33001, by default) is unavailable. If UDP connectivity is lost or cannot be established, then the transfer will continue over the HTTP protocol based on this proxy configuration. Note that the HTTP fallback settings include NTLM authentication credentials (username and password), as well as the host name/IP address and port number. Default is false.
FASP Proxy (Optional) When FASP proxy is enabled, Aspera will pass the DNAT or DNATS (secure) username, server address and port to ascp. To enable FASP proxy, set set <enable/> to true and input your FASP proxy credentials, address (dnat:// or dnats:// for secure FASP proxy) and port. Default is false.
Download Limit (Optional) Download bandwidth limit in Mbps. To let the server decide, leave this setting empty.