Setting Up a Linux Node

1. Verify you have installed IBM Aspera Enterprise Server with a valid Connect Server license on your transfer server.
   Run the following command:

   # ascp -A

   In the resulting output, look for the following phrase:

   Connect Server License max rate

   If you need to update your transfer server license, follow the instructions in IBM Aspera Enterprise Server Admin Guide: Updating Product License.

2. Create a system user account on the node.
   Run the following command:

   # useradd username

   The examples in this topic use xfer_user as an example username.

The following steps use the asconfigurator utility to modify the aspera.conf configuration file, located at /opt/aspera/etc/aspera.conf.

3. Add the user to aspera.conf and set the docroot.
   The directory you choose for the docroot is the absolute path for the transfer user. When this node is added to Console, users cannot access files or folders outside of the docroot.

   CAUTION:

   Aspera recommends that you not use spaces in your docroot. If your docroot contains spaces, you may not receive all email notifications relating to transfer activity.

   Run the following asconfigurator command with the transfer username and the docroot path:

   # asconfigurator -x "set_user_data;user_name,username;absolute,/
                           docroot/path"

   For example:

   # asconfigurator -x "set_user_data;user_name,xfer_user;absolute,/project1"

4. Set up token authorization for the user in aspera.conf.
   Run the following asconfigurator commands to set the encryption key for the user:

   > asconfigurator -x "set_user_data;user_name,username;authorization_transfer_in_value,allow"
   > asconfigurator -x "set_user_data;user_name,username;authorization_transfer_out_value,allow"
   > asconfigurator -x "set_user_data;user_name,username;token_encryption_key,encryption_key"

   The encryption key can be any string of numbers. Aspera recommends a string that is at least 20 characters long. For example:

   > asconfigurator -x "set_user_data;user_name,xfer_user;authorization_transfer_in_value,allow"
   > asconfigurator -x "set_user_data;user_name,xfer_user;authorization_transfer_out_value,allow"
   > asconfigurator -x "set_user_data;user_name,xfer_user;token_encryption_key,gj5o930t78m34ejme9dx"

5. Set the IP address or hostname for the node in the aspera.conf file with the following asconfigurator command:

   # asconfigurator -x "set_server_data;server_name,ip_or_hostname"

   For example:

   # asconfigurator -x "set_server_data;server_name,aspera.example.com"

6. Set up a transfer user account with a Node API username and password.
   Console authenticates to the node machine using a Node API username and password. The following command creates a Node API user and password and associates it with the system user you created.

   Note: Aspera recommends that you use different names for the system user account and transfer user account in order to minimize confusion when tracing transactions and events.
   1. Run the following commands to set up the Node API user:

      # /opt/aspera/bin/asnodeadmin -a -u node_api_username -p node_api_passwd -x system_username --acl-set impersonation

      # /opt/aspera/bin/asnodeadmin -a -u node_user -p XF324cd28 -x svcAspera --acl-set impersonation

   2. Run the following command to check the system user was successfully added to asnodeadmin:

      # /opt/aspera/bin/asnodeadmin -l

      Given a node user named node_user and a system user named xfer_user, the result should be similar to the following example:

                      user       system/transfer user                    acls
      ====================    =======================    ====================
                 node_user                  xfer_user                        

   Adding, modifying, or deleting a node-user triggers automatic reloading of the user database and the node's configuration and license files.

   Note: If the transfer server on your node is running a transfer server before version 3.5.5, the node is not recent enough to support setting the "impersonation" ACL. You must upgrade the node to 3.5.5+ or obtain a patch from Aspera Support.