A
node is a machine running an Aspera transfer server
product (IBM Aspera Enterprise Server, IBM Aspera Connect Server) which has been
configured for
Node API. Aspera web applications authenticate to remote
node services using a Node API username and password. Different nodes may use different
Node API username and password pairs.
Note: The following instructions require you to
have administrative privileges.
-
Verify you have installed IBM Aspera Enterprise Server with a valid
Connect Server license on your transfer server.
Run the following
command:
> ascp -A
If you need to
update your transfer server license, follow the instructions in
IBM Aspera
Enterprise Server Admin Guide: Updating Product License.
-
Create a system user account on the node.
Run the following
command:
# useradd username
This system user account is associated with the Node API account in the
steps below.
The following steps use the asconfigurator utility to modify the
aspera.conf configuration file, located at /opt/aspera/etc/aspera.conf.The following
steps use the asconfigurator utility to modify the
aspera.conf configuration file, located at
/opt/aspera/etc/aspera.conf.
-
Add the user to aspera.conf and set the docroot.
Run the following
asconfigurator command with the node
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"
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.
-
Set up token authorization for the user in
aspera.conf.
Run the following
asconfigurator command to set the
encryption key for the
user:
> 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;token_encryption_key,gj5o930t78m34ejme9dx"
-
Verify persistent storage is enabled in
aspera.conf for use with stats collector.
Run the following
asuserdata command to verify that the
persistent_store parameter is set to
enable:
# /opt/aspera/bin/asuserdata -c
central server option set:
address: "127.0.0.1"
port: "40001"
backlog: "200"
schema_validation: "enable"
mgmt_backlog: "200"
mgmt_port: "0"
transfer_list_path: ""
persistent_store: "enable"
persistent_store_path: ""
persistent_store_max_age: "86400"
persistent_store_on_error: "ignore"
event_buffer_capacity: "1000"
event_buffer_overrun: "block"
compact_on_startup: "enable"
files_per_session: "1000000"
file_errors: "true"
ignore_empty_files: "true"
ignore_skipped_files: "true"
ignore_no_transfer_files: "true"
db_synchronous: "off"
db_journal: "wal"
If persistent storage is not enabled, you must run the
following asconfigurator command to enable it:
> asconfigurator -x "set_central_server_data;persistent_store,enable"
Restart
the Aspera Central service to update the node configuration:
# service asperacentral restart
-
Set up a transfer user account with a Node API username and
password.
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.
Run the following
command:
# /opt/aspera/bin/asnodeadmin -a -u node_api_username -p node_api_password -x username
For
example:
# /opt/aspera/bin/asnodeadmin -a -u shares-node-user -p ****** -x xfer-user
Run the following command to check the system user was successfully
added to
asnodeadmin:
# /opt/aspera/bin/asnodeadmin -l
The
result should be similar to the following
example:
user system/transfer user acls
==================== ======================= ====================
node_api_username username []
-
Install the IBM Aspera Connect Browser Plug-In key.
-
If the .ssh folder does not already exist in the
system user's home directory, run the following command to create the
folder:
# mkdir -p /home/username/.ssh
For
example:
# mkdir -p /home/xfer-user/.ssh
-
If the authorized_keys file does not already
exist, add the aspera_id_dsa.pub public key to the
file by running the following command:
# cat /opt/aspera/var/aspera_id_dsa.pub >> /home/username/.ssh/authorized_keys
-
Transfer the .ssh folder and
authorized_keys file ownership to the system
user by running the following commands:
# chown username:username /home/username/.ssh
# chown username:username /home/username/.ssh/authorized_keys
# chmod 600 /home/username /.ssh/authorized_keys
# chmod 700 /home/username
# chmod 700 /home/username /.ssh
The transfer node is now ready for connection to Shares. For
instructions on adding a node to Shares, see
Adding Nodes.