faspex Installation Guide

Windows XP/2003

Version 1.5.2

Chapter 1 Introduction
Chapter 2 Install faspex: 2.0 Upgrade from a Previous Version; 2.1 Prepare the System; 2.2 Installation; 2.3 Set Up the SSL Certificate
Chapter 3 Configure faspex: 3.1 Configure the Web Server; 3.2 Configure HTTP Fallback; 3.3 Restart faspex
Appendix 1 The Log Files: 2 Uninstall faspex

1. Introduction

Aspera faspex is a file exchange application that built upon Aspera Enterprise Server for centralized transfer solution. With a web-based graphical user interface, faspex allows more advanced management options for fasp high-speed transfer to match your organization's workflow. faspex provides the following features:

Features

fasp™ transport server: Installed upon the Enterprise Server, a transport server that handles fasp™ connections.
Web- and Email-based Interface: Simple web and email interface for exchanging files and directories.
Package Forwarding: A permitted user can forward packages on the server to others without re-transferring.
Permission Management: Manage user permissions through workgroup assignment or direct-configuration.
Post-Processing: Execute custom scripts after a transfer when certain conditions are met.
Email Notification: Customizable Email Notification of faspex events such as when receiving a package.

The most up-to-date document can be found at http://asperasoft.com/support/documentation/faspex.
For further assistance, please contact us at http://asperasoft.com/support.

2. Install faspex

2.0 Upgrade from a Previous Version

If a system has a previous version of faspex installed, follow these steps to backup the faspex data and uninstall the previous version. Make sure the faspex is not in use during the process, any transfers or transactions that are in progress will be interrupted:

Step 1Backup the database

Find the MySQL port number (Generally 4406) in the aspera.conf file:

aspera.conf Location

Win 32bit: C:\Program Files\Aspera\FASP\etc\aspera.conf
Win 64bit: C:\Program Files (x86)\Aspera\FASP\etc\aspera.conf


						<DATABASE

						  ...

						  Port = "4406" 

						  ...

Open the Command Prompt (Start menu > All Programs > Accessories > Command Prompt), first navigate into the directory:

Win 32bit: > cd "C:\Program Files\MySQL\MySQL Server 5.0\bin"
Win 64bit: > cd "C:\Program Files (x86)\MySQL\MySQL Server 5.0\bin"

This example is based on the following settings. Execute the commands with your settings:

MySQL Address:
127.0.0.1 (Localhost)
MySQL User:
root
MySQL User Password:
aspera
MySQL Port:
4406


						> mysqldump -uroot -paspera -h127.0.0.1 -P4406 faspex > faspex_backup.sql

						> mysqldump -uroot -paspera -h127.0.0.1 -P4406 central > central_backup.sql

						> mysqldump -uroot -paspera -h127.0.0.1 -P4406 user_service > us_backup.sql

There shoundn't be error message during the process. Make sure the backup files' size are larger than 0, and store them in a safe place (For example, C:\faspex_backup). You will need these files to restore the data from the previous install.

Step 2 Backup the configuration file

Copy the following files to a safe place (For example, C:\faspex_backup):

C:\faspex\config\
C:\Program Files\Aspera\Faspex\config\*
C:\Program Files\Aspera\FASP\etc\aspera.conf

These files must be removed from the original location, prior to proceeding with the new install. Delete the folders when finished the backup.

Step 3Backup the faspex directory

In the Command Prompt, use the commands to rename the faspex directory as a backup (faspex_old):


					> cd C:\

					> rename faspex faspex_old

Step 4 Remove the faspex services

Before uninstalling the faspex, shut down all relevant services. To do so, go to the Control Panel > Administrative Tools > Services. Stop the following three services:

Aspera Faspex services
Apache Server
Mysql Server

When finished, in the Command Prompt, execute the following commands to remove these services:


						> sc delete "Aspera Faspex"

						> sc delete "Apache2.2"

						> sc delete "MySQL"

Lastly, go to the Control Panel > Add or Remove Programs and remove the following items:

Ruby
Apache
MySQL

The backup and uninstall procedure is now complete. Follow the rest of the instructions to install the new faspex. The database restoration instruction is covered in 2.2 Installation, Step 4.

2.1 Prepare the System

To successfully install Aspera faspex, it is highly recommended to use a computer with a newly-installed operating system. If you have previous version of faspex installed and would like to keep the data while upgrading to the latest version, please contact Aspera Support at http://asperasoft.com/support/.

The following is a list of requirements for your system before installing:

Preparation

Application

Pre-existing Apache web server is not running during the installation.
Pre-existing MySQL Database is not running during the installation.
No Aspera faspex previously installed.

Firewall

Allow inbound connections for Apache HTTP Server, such as TCP port 80.
Allow inbound connections for Apache HTTPS Server, such as TCP port 443.
Allow inbound and outbound connections on TCP port 22 for SSH connections.
Allow inbound and outbound connections on UDP port 33001 for fasp transfers.

2.2 Installation

Follow these steps to set up the faspex:

Step 1 Download and execute the Aspera Enterprise Server installer

Before installing faspex, you must already have Aspera Enterprise Server installed. Download the Enterprise Server installer package, use the login and password provided: http://asperasoft.com/downloads/ent-server

When downloaded, double-click the executable to install the Enterprise Server. In the setup wizard, choose "Typical" install option.

Step 2 Enter the Aspera Enterprise Server License Key

After the installation, go to Start Menu > All Programs > Aspera > Aspera Enterprise Server and launch Aspera Scp. It will prompt for a license key upon first launch.

Step 3 Download and execute the faspex installer

Go to the Aspera download page, find the installer for your platform and download. Use the user name and password provided by Aspera to access: http://www.asperasoft.com/downloads/faspex

When downloaded, execute the installer. During the installation, the installer will prompt you for the following information. Follow the instructions:

Enter the hostname or IP address for your faspex server
Enter email address for faspex admin account
Enter the directory where faspex packages will be stored

Step 4 Restore the backed up database from the previous faspex (Optional)

Follow this instruction if you wish to restore the previous install of the older faspex's database.
When the new faspex is installed, open the Command Prompt and navigate into the faspex directory:

Win 32bit: > cd "C:\Program Files\Aspera\Faspex\"
Win 64bit: > cd "C:\Program Files (x86)\Aspera\Faspex\"

In the faspex directory, execute the following commands to restore the database. Reflect the underlined path and file name to the backed up files:


					> asctl faspex:reload_database faspex C:\faspex_backup\faspex_backup.sql

					> asctl faspex:reload_database central C:\faspex_backup\central_backup.sql

					> asctl faspex:reload_database user_service C:\faspex_backup\us_backup.sql

					> asctl -v faspex:migrate_databases

Step 5 Install the faspex License File

You should find the faspex license key file in the authorization E-mail sent by Aspera, for example aspera.faspex.general.license. Put the ".license" file you received from Aspera into the directory:

32bit: C:\Program Files\Aspera\FASP\etc
64bit: C:\Program Files (x86)\Aspera\FASP\etc

Important: you must only have one license file at a time in the directory, otherwise you will not be allowed to log in. To keep a second license file in the same directory, rename it, for example, add ".bak" to the end of the filename.

Step 6 Add encryption key to aspera.conf

Locate and open the aspera.conf in the following location:

aspera.conf Location

32bit: \Program Files\Aspera\FASP\etc\aspera.conf
64bit: \Program Files (x86)\Aspera\FASP\etc\aspera.conf

In the aspera.conf, locate the following section and replace the underlined value within <encryption_key> tags with your own encryption key-string:


					<name>faspex</name>

					  <authorization>

					    <token>

					      <encryption_key>change-me-secret-key-for-faspex</encryption_key>

					    </token>

					  </authorization>

					...

Step 7 Start faspex Services and Aspera Central

In the Command Prompt (Start > All Programs > Accessories > Command Prompt), navigate into the faspex directory:

32bit: > cd "C:\Program Files\Aspera\faspex"
64bit: > cd "C:\Program Files (x86)\Aspera\faspex"

In the faspex directory, execute the following command to start the faspex:


					> asctl all:start

To restart the Aspera Central to apply the new settings, Go to Control Panel > Administrative Tools > Services, choose the Aspera Central and click Restart.

Step 8 Log in Aspera faspex

When successfully installed, you should be able to connect to the Aspera faspex through a web browser. For example:

Address:
10.0.0.10/aspera/faspex
Username:
admin
Password:
aspera

You can change the administrator's password in the faspex. Go to the Preferences from the faspex menu, enter your password under Change Password section.

2.3 Set Up the SSL Certificate

If you wish to implement the SSL (Secure Sockets Layer) certificate, follow these steps:

Step 1 Order a signed certificate from a SSL certificate provider

Order a signed SSL key from a certificate authority, and follow the key provider's instructions to generate and submit both of your private key and the Certificate Signing Request (CSR) to acquire the certificate. Here is a list of the certificate authority.

Step 2 Edit the Apache's configuration file to use the new certificate

Use a text editor to open the Apache's SSL configuration file:

Apache's SSL Configuration File

32bit Win: \Program Files\Common Files\Aspera\Common\apache\conf\extra\httpd-ssl.conf
64bit Win: \Program Files (x86)\Common Files\Aspera\Common\apache\conf\extra\httpd-ssl.conf

In the httpd-ssl.conf, locate the following two lines, change the path or file name to point to the new certificate and the private key files. Save the file when finished:

32bit Windows

SSLCertificateFile "C:/Program Files/Common Files/Aspera/Common/apache/conf/server.crt" SSLCertificateKeyFile "C:/Program Files/Common Files/Aspera/Common/apache/conf/server.key"

64bit Windows

SSLCertificateFile "C:/Program Files (x86)/Common Files/Aspera/Common/apache/conf/server.crt" SSLCertificateKeyFile "C:/Program Files (x86)/Common Files/Aspera/Common/apache/conf/server.key"

Step 3 Install the Intermediate CA Certificate file (Optional)

Your certificate provider may require you to also install an Intermediate CA Certificate file. For example, if the Intermediate CA certificate is in the directory:

C:\serv-certificate\int-ca.crt

Open the same SL configuration file as Step 2 (httpd-ssl.conf), add or edit the parameter SSLCACertificateFile to point to the certificate:

SSLCACertificateFile "C:/serv-certificate/int-ca.crt"

Step 4Restart Apache to apply the new settings

To restart Apache to apply the new settings, go to Control Panel > Administration Tools > Services, and restart the Apache HTTPD Server (Aspera).

3. Configure faspex

At this point, faspex should be set up and functional. This section includes additional settings of both the Apache web server and Http Fallback setting, follow the instructions for further customization.

3.1 Configure the Web Server

Follow the steps to go through common faspex web server settings:

Step 1 Navigate into the faspex directory

Open Command Prompt (Start > All Programs > Accessories > Command Prompt), enter the command to navigate into Console directory:

32bit: > cd "C:\Program Files\Aspera\faspex"
64bit: > cd "C:\Program Files (x86)\Aspera\faspex"

Step 2 Print and change the hostname

During the installation, you should have the faspex's hostname configured. First, use the command to print the current hostname:

> asctl faspex:shared:apache:hostname

To change the hostname, use the command and replace the underlined value with the hostname you want to use:

> asctl faspex:shared:apache:hostname www.new-host.com

When changed, enter the new url to access the faspex. In this example, use the address:

https://www.new-host.com/aspera/faspex

Step 3 Print and change the faspex namespace

By default, faspex uses the namespace /aspera/faspex. To print the current namespace, use the command:

> asctl faspex:uri_namespace

To set the namespace to, for example, /faspex, use the command the change it and restart partial services to apply the settings:


					> asctl faspex:uri_namespace /faspex

					> asctl faspex:all:stop

					> asctl faspex:all:start

When changed, faspex's URL should be the server's address followed by the new namespace. In this example, use the address:

https://10.0.0.10/faspex

Step 4 Set HTTP and HTTPS ports

By default, faspex's web servers are running on TCP/80 (HTTP) and TCP/443 (HTTPS). To use different ports, use the following commands, and replace the underlined values with your port numbers:

HTTP: > asctl faspex:shared:apache:http_port 7080
HTTPS: > asctl faspex:shared:apache:https_port 7443

If you change these two ports, reflect the settings on the system firewall.
When the port numbers are changed, reflect them in the url. In this example, use the address:

https://10.0.0.10:7443/aspera/faspex

3.2 Configure HTTP Fallback

HTTP fallback is an alternative transfer path for Aspera clients that don't have the Internet connectivity required for fasp™ ports (By default, UDP port 33001). When the UDP connectivity is lost or cannot be established, the transfer will be continued over the HTTP protocol. If the transfer encryption is enabled, the transfer will be HTTPS.

To configure HTTP Fallback for faspex, follow these steps:

Step 1 Review the HTTP server settings in aspera.conf

Locate and open the aspera.conf in the following location:

aspera.conf Location

32bit: \Program Files\Aspera\FASP\etc\aspera.conf
64bit: \Program Files (x86)\Aspera\FASP\etc\aspera.conf

In the file, find the following section. Change the underlined values if you wish to use different ports for HTTP Fallback transfers:


					<http_server>

					  <enable_http>1</enable_http>

					  <enable_https>1</enable_https>

					  <http_port>8000</http_port>

					  <https_port>8001</https_port>

					</http_server>

Step 2 Launch asperahttpd

Go to Control Panel > Administrative Tools > Services, select asperahttpd and click start.

Step 3 Configure firewall

Open ports for HTTP and HTTPS Fallback. In this example, open TCP port 8000 and 8001.

Step 4 Enable HTTP Fallback in faspex

In faspex, navigate into Server Admin > Aspera Central Server, check to enable the HTTP Fallback. Also specify the same port number.

To stop HTTP Fallback, go to Control Panel > Administrative Tools > Services, select asperahttpd and click Stop.

3.3 Restart faspex

If faspex is not working properly, it is recommended to restart faspex services. Follow the instructions for your platform:

Step 1 Navigate into faspex's directory in Command Prompt: Open Command Prompt (Start > All Programs > Accessories > Command Prompt), enter the command to navigate into the faspex directory:
> cd "C:\Program Files\Aspera\Faspex"
Step 2 Stop all services: In the faspex directory, execute the command:
> asctl faspex:all:stop
Step 3 Start all services: Execute the command to start all services:
> asctl faspex:all:start

Appendix 1. The Log Files

The Aspera faspex log files are located in the directory:

Log File Directory

32bit: C:\Program Files\Aspera\Faspex\log
64bit: C:\Program Files (x86)\Aspera\Faspex\log

Appendix 2. Uninstall faspex

To uninstall faspex, follow the steps:

Step 1 Uninstall all faspex Services

Open Command Prompt (Start > All Programs > Accessories > Command Prompt), navigate into the faspex directory:

32bit: > cd "C:\Program Files\Aspera\faspex"
64bit: > cd "C:\Program Files (x86)\Aspera\faspex"

In the faspex directory, execute the following commands to uninstall all services associated to faspex:


					> asctl -b all:stop

					> asctl all:uninstall_service

Step 2 Uninstall faspex application

Open Control Panel > Add/Remove Programs. Select Aspera Faspex and click Remove.

Reference

faspex Admin Guide
faspex User Guide