This topic is for system administrators who plan to install PhixFlow. The pages in this topic describe how to install a new instance of PhixFlow.
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
- configured a database instance or schema and the user or login credentials
- installed a (Linux or Windows) server to act as the web-application (webapp) host.
Optionally, you can install a Linux or Windows server to act as the reverse proxy / HTTPS proxy.
Summary Installation Instructions
Tha pages in this topic guide you through a complete 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. | |
| Recommended | For secure communications, you must configure Tomcat to use HTTPS. PhixFlow must be configured:
| |
| 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. In this configuration, the reverse proxy runs as root, which allows it to use privileged ports (up to 1000), and forwards requests to the web server which runs as a non-privileged user (normally 'tomcat'), on non-privileged ports (above 1000). This solution requires that:
On Linux, use Pound as a reverse proxy. On Windows servers, you can use IIS as a reverse proxy. |
| 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 contact PhixFlow Support for details. Logon 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. |
| Optional | SQLServer Integrated Authentication | Enable server support for integrated user authentication. |
| Required | Install PhixFlow Webapp | Copy the PhixFlow webapp from the unpacked release package into Tomcat and configure it. |
| Required | Start PhixFlow on the Client | Check that the application is running by starting the client and logging in with the username startup and password: Startup. |
Tomcat on Linux
Do not run Tomcat as root on Linux as this constitutes a security risk.
System Configuration After Installation
After PhixFlow is installed, there are system set-up and configuration tasks:
- Configure the system directories; see System Configuration. The Temporary File Location is especially important as it is used when exporting and importing files between PhixFlow instances.
- Create new users, including at least one administrator; see User Administration. When you have a working administrator login, you must disable or delete the startup user.
- Optionally, configure PhixFlow to integrate with other authentication systems
- Configure Active Directory Integration: users are authenticated using one or more Active Directory servers in addition to users that are defined locally within the PhixFlow database.
- Configure SAML Integration: map the PhixFlow user groups to user groups in your existing single-sign-on system.
- 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.