Configuring a Windows node for Faspex

Edit online

A node is any server running IBM Aspera High-Speed Transfer Server (HSTS). Aspera web applications, such as Faspex, communicate with a node through the IBM Aspera Node API.

The instructions below assume you have already installed HSTS 4.3+ on your server. For instructions on installing IBM Aspera High-Speed Transfer Server Admin Guide: Installing HSTS.

Verify that the node is running HSTS 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 High-Speed Transfer Server Admin Guide: Updating Product License.
Create the faspex system user account on the node.
Click Control Panel User Accounts and add a new account named faspex. This system user account is associated with the Node API account in the steps below.
After creating a Windows user account, log in as that user at least once for Windows to set up the user's home folder.
Create the faspex_packages directory.
```
cd C:\
mkdir faspex_packages
```

The asconfigurator utility modifies the aspera.conf configuration file, located at: C:\Program Files (x86)\Aspera\Enterprise Server\etc\aspera.conf.

Add the transfer 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 Faspex, users cannot access files or folders outside of the docroot.
CAUTION:
Do 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,faspex;absolute,\faspex_packages"
```
Set up token authorization for the user in aspera.conf.
1. 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,token"

# 
asconfigurator -x "set_user_data;user_name,username;authorization_transfer_out_value,token"
```
  For example:
```
# 
asconfigurator -x "set_user_data;user_name,faspex;authorization_transfer_in_value,token"

# 
asconfigurator -x "set_user_data;user_name,faspex;authorization_transfer_out_value,token"
```
2. Configure dynamic key generation:
```
asconfigurator -x "set_node_data;token_dynamic_key,true"
```
3. Set a Redis master key using askmscli. The master key must be a unique random 256-bit key. The example below uses openssl to generate the key. This Redis master key will be used to encrypt the dynamic token encryption key.
```
#
openssl rand -base64 32 > redis_primary_key_file

#
type redis_primary_key_file | askmscli.exe -s redis-primary-key
```
4. Initialize the transfer user's keystore:
```
askmscli.exe -u username -i -L- -DD
```
5. Set the store for the user that runs asperanoded. The default user is svcAspera. The username might change if you are not using the default user:
```
askmscli.exe -i -u svcAspera
```
For more information, see the IBM Aspera High-Speed Transfer Server:Secrets Management with askmscli section.

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"

Configure the node for HTTP and HTTPS fallback.
HTTP fallback serves as a backup transfer method when Aspera FASP transfers (UDP port 33001, by default) is unavailable. When HTTP fallback is enabled and UDP connectivity is lost or cannot be established, the transfer continues over HTTP or HTTPS. Faspex requires you to enable HTTP and HTTPS and use the ports 8080 and 8443, respectively:
```
asconfigurator -x "set_http_server_data;enable_http,true"
asconfigurator -x "set_http_server_data;http_port,8080"
asconfigurator -x "set_http_server_data;enable_https,true"
asconfigurator -x "set_http_server_data;https_port,8443"
```
Restart the asperahttpd service. Go to Control Panel Administrative Tools Computer Management Services and Applications Services, click IBM Aspera HTTPD, and click Restart.
Enable activity logging on the node:
```
asconfigurator -x "set_server_data;activity_logging,true"
```
If you do not enable activity logging, Faspex cannot retrieve package information and your users cannot download packages.
You must restart the asperanoded service for changes made using the asconfigurator utility (which modifies the aspera.conf configuration file) to take effect. Go to Control Panel > Administrative Tools > Computer Management Services and Applications Services, click IBM Aspera NodeD, and click Restart.
Configure a HSTS transfer user account with a Node API username and password.

Faspex communicates to the HSTS transfer user account through the Node API to start transfers on the node.

For instructions on adding users to HSTS, see the IBM Aspera High-Speed Transfer Server Admin Guide: Setting Up Users.
1. Set up the Node API user:
```
asnodeadmin -a -u node_api_username -p node_api_passwd -x system_username
```
  Note: Use different names for the system user account and transfer user account in order to minimize confusion when tracing transactions and events.
  For example:
```
asnodeadmin -a -u node_user -p XF324cd28 -x faspex
```
2. Run the following command to check that the system user was successfully added to asnodeadmin:
```
asnodeadmin -l
```
  Given a node user named node_user and a system user named faspex, the output should be:
```
                user       system/transfer user                    acls
====================    =======================    ====================
           node_user                  faspex    [ ]              
```
Copy the IBM Aspera Connect public key to authorized_keys to allow Connect to connect to Faspex.
1. If the .ssh folder does not already exist in the system user's home directory, run the following commands to create the folder:
```
cd "C:\Documents and Settings\username"
mkdir .ssh
```
2. If the authorized_keys file does not already exist, use a text editor to create or edit the following file: C:\Documents and Settings\username\.ssh\authorized_keys.
3. Copy the contents of the aspera_tokenauth_id_rsa.pub (C:\Program Files (x86)\Aspera\Enterprise Server\var\aspera_tokenauth_id_rsa.pub) public key to the file.
  
  Note: When you copy the contents inside aspera_tokenauth_id_rsa.pub remove /bin/ from the command="/bin/aspshell -t" to make it be command="aspshell -t",...., or use the full path command="\"C:\Program Files\Aspera\Enterprise Server\bin\aspshell.exe\" -t",...
  
  The file must be named "authorized_keys" without file extensions. Some text editors add a .txt extension to the filename automatically. Be sure to remove the extension if it was added to the filename.

You can now add this server to Faspex as a node.