Introduction
This section describes how to install PhixFlow.
Pre-conditions
Before installation starts it is assumed that all system pre-requisites have been completed as documented in PhixFlow System Planning, specifically that
...
Prerequisites
Before you start installing PhixFlow, please complete the steps in Planning your PhixFlow System. Your IT system must meet the PhixFlow system requirements. In particular, you must have:
- installed a database server,
- you have configured a database instance / or schema and the user / or login credentials
- you have installed a (Linux or Windows) server to act as the web-application (webapp) host.
and, optionallyOptionally, that you
...
can install a Linux or Windows server to act as the reverse proxy / HTTPS proxy.
Summary Installation
...
Instructions
The pages in this topic guide you through a complete installation, follow these instructions as given.
...
PhixFlow installation. A summary of the steps is:
...
| Required or recommended | Page with details | Summary |
|---|---|---|
| Required if Java is not already installed | Install Java | Download and install Java. |
| Required if Tomcat is not already installed | Download and install the Apache Tomcat web-application (webapp) server. |
Download / Unpack PhixFlow
If you have not been given the PhixFlow package to install, you can download any published version from our support FTP site. Please contact PhixFlow Support for details.
Logon to the webapp host and unpack the PhixFlow release package.
Configure the Database
Use the installer to populate the database.
Install the PhixFlow Web Application
Copy the PhixFlow webapp from the unpacked release package into Tomcat and configure it. See Install PhixFlow Webapp for details.
Start PhixFlow
You should now be able to start Tomcat, start the PhixFlow client and login as the startup user (password: 'Startup').
System Configuration
Configure the directories under System Directories. See System Configuration for details.
The Temporary File Location is especially important as it is used when Exporting / Importing files.
Create Users
You should immediately create new users, including at least one administrator, then disable or delete the startup user.
Import Component Templates (if required)
Import the component templates file if this is your first PhixFlow instance.
See Import Templates and Formats for more information on when and how to install the templates.
Configure HTTPS
PhixFlow should always be configured to allow HTTPS connections to the webapp and to disable HTTP access.
...
| Recommended | You are responsible for ensuring all PhixFlow communication is secure.
| |
| Recommended | Linux: Install Pound Reverse Proxy | If you want to make your web server visible on the default ports (e.g. on Linux, http: 80, https: 443) |
...
we recommend that you use a reverse proxy to terminate the HTTPS session and to forward web requests using HTTP to the Tomcat server. The proxy and Tomcat servers must run on a private network or on the same server and the Tomcat server must not be directly accessible to normal users. In this configuration, the reverse proxy runs as root, which allows it:
|
...
|
...
Options for reverse proxy servers are:
|
Reverse Proxy
We recommend using a reverse proxy to terminate the HTTPS session and to forward web requests using HTTP to the Tomcat server. This solution requires that the proxy and tomcat servers run on a private network (or on the same server), and that the tomcat server is not directly accessible by normal users.
To install a reverse proxy on Linux, see Install the 'pound' reverse proxy.
To configure IIS as a reverse proxy on Windows, see here.
Tomcat
It is also possible to configure HTTPS directly in tomcat.
Configure for Resilience (optional)
PhixFlow can be configured to have a hot stand-by webapp shadowing the active webapp, such that the standby webapp will automatically take over in the event that the active server fails.
See Configuring for Resilience for details.
Configure for Active Directory Users (optional)
PhixFlow can be configured to allow users to be validated against one or more Active Directory servers in addition to users that are defined locally within the PhixFlow database.
See Configure Active Directory Integration for details.
Configure for SAML / Single Sign-on Users (optional)
PhixFlow can be configured to allow users to be validated against a single SAML Identity Provider in addition to users that are defined locally within the PhixFlow database.
See Configure SAML Integration for details.
Other Resources
The following pages may contain additional useful resources.
| Required | Unpack PhixFlow Release Package | If you do not already have the PhixFlow package to install, you can download it from our support FTP site. Please email support@phixflow.com. Log on to the webapp host and unpack the release package. |
| Required | Install the PhixFlow Database Schema | Create a database user and tables. Populate the tables with initial configuration data and set the customer name. See also the details in Database URLs. |
| Required | Configure a Keystore for Database Credentials | Create a keystore for the database credentials and their aliases. Configure the following files to use the keystore:
|
| Optional | SQLServer Integrated Authentication | Enable server support for integrated user authentication. |
| Required | Install the PhixFlow Webapp | Copy the PhixFlow webapp from the unpacked release package into Tomcat and configure it. |
| Required | Start PhixFlow and Configure | Check that the application is running by starting the client and logging in with the username startup and password: Startup. |
After Installation
Once PhixFlow is installed, see Administration for details of the configuration steps required immediately after installation, as well as the ongoing configuration and maintenance tasks.