Configuring for Shares

The steps below show how to set up IBM Aspera Enterprise Server as a transfer server for IBM Aspera Shares. The procedure assumes you have already set up your Shares application. For general information on setting up a transfer server (using the Node API), see Set up for Node API.

  1. Install Enterprise/Connect Server.

    Follow the instructions in Installation and Upgrades to install Enterprise Server either locally (on the same host as Shares) or remotely.

    The steps below must be performed as root.

  2. Create an Aspera transfer user.
    The Aspera transfer user authenticates the actual ascp transfer, and must be an operating system user on the node. If the operating system user does not exist, create the user.Create a user account—for example, aspera_user_1—by running the following command:
    # useradd aspera_user_1

    Configure the operating system user in Enterprise Server to make it an Aspera transfer user. For instructions, see Setting Up Users or Setting Up Transfer Users (Terminal).

    Note: The Aspera transfer user must have a docroot configured (see aspera.conf - File System). After setting the user's docroot, restart the Node service, as described in Configuring the Server for the Node API.
  3. Configure the Aspera transfer user with a Node API username and password.
    Aspera's Web applications authenticate to the remote node service using a Node API username and password. The following command creates a Node API username and password, and associates it with a file transfer user, in this example aspera_user_1. Different nodes may use different Node API username-password pairs.
    # /opt/aspera/bin/asnodeadmin -a -u node_api_username -p node_api_passwd -x aspera_user_1
  4. Copy the public key to the transfer user’s SSH file.

    For example, if the file transfer user is aspera_user_1, the standard location for the public key is in the user's home directory, as follows:

    /home/aspera_user_1/.ssh/authorized_keys
    

    The Aspera-provided key file is located in:

    /opt/aspera/var/aspera_tokenauth_id_rsa.pub
    

    On the command line, run the following to create the user's public key folder (if it does not already exist):

    # mkdir /home/aspera_user_1/.ssh

    Run the following commands to create the keyfile authorized_keys (if it does not already exist), and append the key text to it. Update the directory permissions and ownership if necessary.

    # cat /opt/aspera/var/aspera_tokenauth_id_rsa.pub >> /home/aspera_user_1/.ssh/authorized_keys

    Run the following commands to change the key directory and keyfile's ownership to user aspera_user_1, to allow access by the aspera_user_1 group, and to set permission bits:

    # chown -R aspera_user_1:aspera_user_1 /home/aspera_user_1/.ssh/authorized_keys
    # chmod 600 /home/aspera_user_1/.ssh/authorized_keys
    # chmod 700 /home/aspera_user_1
    # chmod 700 /home/aspera_user_1/.ssh 
  5. (Optional) Change HTTPS port and/or SSL certificate.
    The Aspera Node API provides an HTTPS interface for encrypted communication between node machines (on port 9092, by default). To modify the HTTPS port, see Configuring the Server for the Node API. For information on maintaining and generating a new SSL certificate, see Setting up SSL for your Nodes.
  6. Configure server settings.
    In a Terminal window, run the following commands to set the server name with the name or IP address of your server, enable persistent storage (persistent storage is enabled by default), and enable HTTP and HTTPS:
    # asconfigurator -x "set_server_data;server_name,server_ip_or_name"
    # asconfigurator -x "set_central_server_data;persistent_store,enable"
    # asconfigurator -x "set_http_server_data;enable_http,true"
    # asconfigurator -x "set_http_server_data;enable_https,true"
  7. Enable token authorization for the transfer user.
    • From the Enterprise Server GUI: Click Configuration, select the transfer user, and click the Authorization tab. In the rows for Incoming Transfers and Outgoing Transfers, select the Override box, then select token from the dropdown menu under Effective Value. In the row for Token Encryption Key, select the Override box, then enter the encryption key in the field under Effective Value. The encryption key should be a string of random characters (at least 20 recommended). For illustrated instructions, see Setting Up Token Authorization.
    • Using the command line: In a Terminal window, run the following commands:
      # asconfigurator -x "set_user_data;user_name,username;authorization_transfer_in_value,token"
      # asconfigurator -x "set_user_data;user_name,username;authorization_transfer_in_value,token"
      # asconfigurator -x "set_user_data;user_name,username;token_encryption_key,encryption_key"
      The encryption key should be a string of random characters (at least 20 recommended).

    Alternatively, you can configure token-authorization settings to apply to all users in a group or to apply them globally for all users. For more information, see User, Group and Default Configurations.

  8. Restart Aspera Central and Aspera NodeD to activate your new configuration.
    Run the following command in a Terminal window to restart asperacentral:
    # /etc/init.d/asperacentral restart
    Run the following commands to restart asperanoded:
    # /etc/init.d/asperanoded restart
  9. Ensure that the firewall is set up correctly on your transfer server
    For details, see Configuring the Firewall.