...
| Info |
|---|
Unix/ Linux installation: these instructions guide you to setting up tomcat to run as a service under the classic init mechanism on unix/ linux (System V) since this will be available on all platforms, but you should consider using Upstart, a more modern init mechanism that will be available on most modern unix/ linux distributions. Installation using upstart is widely covered on the web. Further, at some versions of tomcat, on certain unix/ linux versions, a complete tomcat installation can be performed using a few simple package commands. Before you begin, a web search for tomcat installation at the desired version of tomcat, on the installed version of your unix/ linux distribution, may give you a much simpler installation method. However you install tomcat, please note the settings that are needed under configuring tomcat |
Download
The System Administrator should have set up a linked directory structure like [c:]/opt/tomcat. The details of this may differ between installations so from this point on, the “root” tomcat directory will be referred to as $TOMCAT.
Download the appropriate version of Tomcat from tomcat.apache.org and unpack (unzip/uncompress) into the $TOMCAT. (Refer to Compatibility Guide and Upgrade Planning for supported versions).
Install
Some instructions are given here for installing tomcat, and making it run as a service. You should ensure that any installation meets with your company standards.
Installing on windows
Follow these instructions.
Installing on unix/ linux
Follow these instructions.
| Anchor | ||||
|---|---|---|---|---|
|
Having completed the basic tomcat installation, stop the tomcat service then make the following changes:
conf/context.xml: cache settings
The default Tomcat cache settings are insufficient for PhixFlow:
...
| Code Block | ||
|---|---|---|
| ||
<Context>
<!-- lines omitted -->
<Resources allowLinking="true" cachingAllowed="true" cacheMaxSize="1000000" />
</Context> |
| Note | ||
|---|---|---|
You do not need to read this note to complete the tomcat configuration; these notes are provided for a reference of why we have recommended certain settings in the connection configuration. Cache Max Size
Tomcat caches static files in memory so that it can respond faster. The cache has a max. size to stop it taking up too much memory. PhixFlow's static files (things like icons) are collectively too large to fit in the default |
conf/server.xml: Connector settings
Edit $TOMCAT/conf/server.xml:
...
- Use the required port number (port="8080"). Tomcat defaults to port 8080 for HTTP, but you may need to use a different port if you are running other web servers on the same host.
- Enable compression (compression="force"). Compressing responses from the server is particularly important if you are going to access the PhixFlow server over a slow connection (e.g. a mobile data connection).on")
After editing, the <Connector/> block should look like this:
| Code Block | ||
|---|---|---|
| ||
<!-- Define a non-SSL HTTP/1.1 Connector on port 8080 -->
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000"
redirectPort="8443"
compresscompression="forceon"/> |
Remember to enable this port in the server’s firewall (if enabled).
| Note | ||
|---|---|---|
You do not need to read this note to complete the tomcat configuration; these notes are provided for a reference of why we have recommended certain settings in the connection configuration. Compression
Turning compression on reduces the amount of data passed between a client (i.e. a web browser on someone's computer), so this setting should improve the performance of the PhixFlow front end, especially if users are going to access the front end over a slow connection. |
web.xml: Session timeout
The default session timeout period is 30 minutes. We recommend that you You can change this to a longer different period , e.g. 12 hours (720 minutes) .by doing the following:
Edit $TOMCAT/conf/web.xml
...
| Code Block | ||
|---|---|---|
| ||
<session-config> <session-timeout>720</session-timeout> </session-config> |
Pre-installed Web Applications
| Warning |
|---|
We recommend that you remove all web applications that are provided as part of the Tomcat installation as they are not required for PhixFlow's normal operation and constitute potential security loopholes. |
Supplied Web Applications
Tomcat Manager Webapp
The Manager Webapp is disabled by default.
...
These are the pre-installed web apps, in more detail.
| Supplied Web Application | Description |
|---|---|
| ROOT | The ROOT web application presents a very low security risk but it does include the version of Tomcat that is being used. The ROOT web application should normally be removed from a publicly accessible Tomcat instance, not for security reasons, but so that a more appropriate default page is shown to users. |
| Documentation | The documentation web application presents a very low security risk but it does identify the version of Tomcat that is being used. It should normally be removed from a publicly accessible Tomcat instance. |
| Examples | The examples web application should always be removed from any security sensitive installation. |
| Manager | The Manager application allows the remote deployment of web applications and is frequently targeted by attackers due to the widespread use of weak passwords and publicly accessible Tomcat instances with the Manager application enabled. |
| Host Manager | The Host Manager application allows the creation and management of virtual hosts - including the enabling of the Manager application for a virtual host. |
Database JDBC Drivers
The drivers needed to connect to PhixFlow’s own database are included within the release pack and no action is needed.
...