Product Setup

To install Connect Server, log into your computer with root permissions.

Important: If this is a product upgrade, review all prerequisites described in Before Upgrading or Downgrading.
  1. Download the IBM Aspera product installer.
    Use the credentials provided to your organization by Aspera (not your personal Aspera ID) to access:

    https://downloads.asperasoft.com/en/downloads/4

    If you need help determining your firm's access credentials, contact your Aspera account manager.

  2. For product upgrades, ensure you have prepared your machine to upgrade to a newer version.
    Although the installer performs your upgrade automatically, Aspera highly recommends completing the tasks described in Before Upgrading or Downgrading. If you do not follow these steps, you risk installation errors or losing your configuration settings.
  3. Run the installer
    To start the installation, double-click the installer package. Follow the onscreen instructions to go through the installation process.
  4. Installation troubleshooting.
    If the installer freezes during installation, another Aspera product might be running on your computer. To stop all FASP transfer-related applications and connections, see Before Upgrading or Downgrading.
  5. Install the license or set up your entitlement, depending on your account type (you only do one).
    To Install a License:
    1. Launch the application.
      Click Macintosh HD > Applications > Aspera Enterprise Server. .
      Note: FOR OS X 10.8+: When you run Connect Server for the first time, you are prompted to install Java because OS X 10.8+ does not come with it pre-installed.
    2. Enter the license.
      The Enter License window opens automatically when the application is first launched. Either click Import License File and select the license file, or Paste License Text to copy-and-paste the license file's content. The license information appears in the window.
    3. Verify that the license information is correct and click Close.
    To update your product license after the installation, see Updating the Product License.

    To Set Up an Entitlement:

    Run the following commands to start the ALEE service, restart the Aspera NodeD service, and register your entitlement:
    $ sudo /Library/Aspera/bin/asalee-config.sh enable
    $ sudo launchctl stop com.aspera.asperanoded
    $ sudo launchctl start com.aspera.asperanoded
    $ sudo /Library/Aspera/bin/alee-admin register customer_id entitlement_id

    The output returns the Customer ID and License ID, what type of license is enabled, the license status, and when the license server was last reached.

  6. Edit OpenSSH authentication methods.
    1. Open your SSH Server configuration file from /etc/ssh/sshd_config with a text editor.
    2. To allow public key authentication, set PubkeyAuthentication to yes. To allow password authentication, set PasswordAuthentication to yes.
      Important: macOS servers must have PasswordAuthentication to yes.

      For example,

      ...
      PubkeyAuthentication yes
      PasswordAuthentication yes
      ...
    3. Enable SSH-based services on Mac OSX.
      The System Integrity Protection feature in Mac OSX 10.11 (El Capitan) and later version blocks SSH-based services, which are required for Aspera transfers. Make the following changes to enable Aspera services. In the sshd_config file, uncomment the setting PermitUserEnvironment and change the value to yes.
    4. Save the file then reload the SSH service.

      Click Apple menu > System Preferences > Sharing. Clear and then reselect Remote Login from the left panel. In the Allow access for: option, select All users, or specify individual user accounts for the FASP connections.

    5. To further secure your SSH Server, see Securing Your SSH Server.
  7. For Mac OS X 10.11 and later, set the SSH path for transfer users.
    1. Create a file named environment for every transfer user in the following location:
      /Users/username/.ssh/
    2. Paste the following content into the file:
      PATH=/bin:/usr/bin:/usr/sbin:/sbin:/usr/local/sbin:/usr/local/bin:/opt/pkgconfig/bin:/Library/Aspera/bin:/Library/Aspera/sbin

      This sets the PATH variable for remote connections.

    3. To allow local transfer users to run ascp commands, paste the same content, prefaced with export, into the following file, which you may need to create:
      /Users/username/.bash_profile
    For more information, see the Aspera knowledge base article Workaround to use Aspera transfer servers on Mac OS X 10.11 El Capitan.
  8. Secure your server or update your existing configuration.
  9. Set up your new Connect Server's web UI (or verify your web UI settings after an upgrade).
    Your IBM Aspera transfer product is now installed. Additional steps are required to configure the web UI, see Set up the Connect Server Web UI.

Upgrade Follow up

  1. If you were using the Aspera Watch Service or Watch Folders in version 3.6.1 or earlier, manually migrate any services that are run by a user other than root.
    The installer does not automatically migrate Watch or Watch Folder services for users other than root, and you must manually start their services after upgrade:
    1. Confirm that the user has a docroot set in aspera.conf.
      To view the user's settings, run:
      $ /opt/aspera/bin/asuserdata -u user

      If a value is not set for absolute in the docroot option set section, set a docroot by running the following command:

      $ /opt/aspera/bin/asconfigurator -x "set_user_data;user_name,username;absolute,docroot"
    2. Confirm that the user has permissions to write to the log directory.
      To view the log directory settings, run:
      $ /opt/aspera/bin/asuserdata -a

      Look for the values for rund_log_dir and watch_log_dir. If they are set to "AS_NULL", then the logs write to the default directory (/var/log/messageshomedir/Library/Logs/Aspera/).

    3. Start Watch and Watch Folder services for the user by running the following commands:
      $ /opt/aspera/sbin/asperawatchd --user username
      $ /opt/aspera/sbin/asperawatchfolderd --user username
  2. If you are updating a Files node, restore the Files data to the Redis database.
    1. Stop the Aspera NodeD service.
      $ sudo launchctl stop com.aspera.asperanoded
    2. Flush existing data from the Redis database on the new node.
      $/opt/aspera/bin/asredis -p 31415 FLUSHALL
    3. Load the backup database file into the new node database.
      $ cat /opt/aspera/bin/appendonly.aof | asredis --pipe -p 31415
    4. Restart the Aspera NodeD service.
      $ sudo launchctl start com.aspera.asperanoded
  3. If the Redis database is run on another system: Update the KV store keys to the latest format.
    The local Redis database schema is automatically updated by the installer, but non-local Redis databases must be manually updated by running the following command as root:
    # /Library/Aspera/bin/asnodeadmin --db-update
  4. If you have a backup of modified daemon start up scripts for Aspera Central and Aspera NodeD services, copy your modifications into the new versions of these scripts. Restart the services to activate your changes.
  5. For all upgrades: Validate aspera.conf.
    The aspera.conf file is not overwritten during an upgrade and your configurations are preserved. However, the XML formatting, parameters, and acceptable values may have changed between your old version and new version. Run the following command to check aspera.conf for XML form and valid configuration settings:
    $ /opt/aspera/bin/asuserdata -v