Set up HSTS for Node API
HSTS must be configured to use the Aspera® Node API. You can use the asnodeadmin tool to set up the server and manage the Node API. The Node API uses a Redis database, which can be backed up and restored in different ways, depending on what information you need to preserve.
Overview: Aspera Node API The Aspera Node API is a feature of HSTS that provides a REST API for full programmatic control of the Aspera transfer server environment. The asperanoded daemon (which is run by the asperadaemon user), provides node-specific services such as browsing, searching, creating, and deleting files and directories, and setting up transfers over HTTP or HTTPS.Node API setup The Aspera Node API comes with your installation of HSTS . To use it, you must configure your product and create Node API credentials.Node Admin tool Use the asnodeadmin tool to manage (add, modify, delete, and list) Node API users. Root privileges are required. Configuring the Aspera NodeD service The IBM Aspera NodeD Service handles HTTP/HTTPS requests to HSTS . You can configure server settings that include the hostname, HTTP/HTTPS ports, the address and port of the Redis database, and SSL certificates.Securing the Node Service behind a reverse proxy If you are going to expose asperanoded to the internet, use a reverse proxy (Nginx is provided in your installation) . For example, if you want to use an HSTS instance with IBM Aspera on Cloud (AoC ), as a user-managed tethered node , you must use a reverse proxy with it. Backing up and restoring the node user database records These instructions describe how to back up and restore your Node API user data up to the time of the backup operation. Backing up and restoring access keys (tenant data) Access keys can be backed up and restored by using the asnodeadmin tool. Only primary access keys can be directly backed up, not subaccess keys, but backing up a primary access key backs up all associated subaccess keys, too.Backing up and restoring a node database These instructions describe how to back up and restore the entire Redis database of a node, which includes Node API users, their access keys, and transfer history. If your transfer server is an IBM Aspera on Cloud (AoC ) node, migrate AoC data from one node to another by backing up the Redis database on the original node and restoring the database on a new node.Setting up SSL for your nodes The Aspera Node API provides an HTTPS interface for encrypted communication between nodes (on port 9092, by default). For example, if you are running the IBM Aspera Faspex web UI or the IBM Aspera Shares web UI on one computer, you can encrypt the connection (by using SSL) with your transfer server or file-storage node on another computer. HSTS nodes are preconfigured to use Aspera default, self-signed certificate (aspera_server_cert.pem). You might need to create a new certificate or install a valid, signed certificate, such as when you are configuring HSTS as a IBM Aspera on Cloud node.Installing SSL certificates Install a valid and signed SSL certificates on your HSTS . The SSL certificates are asperanoded and asperahttpd .