eiConsole v.24R1
Documentation

eiPlatform

Installation Guide – Linux

Step 1: Installing OpenJDK Java 17

Install the JDK by first updating the package manager cache by running the following commands:

You should see the following output:

Step 2: Download and Install Apache Tomcat 10

For security purposes, Tomcat should run under a separate, unprivileged user. Run the following command to create a user called tomcat:

By supplying /bin/false as the user’s default shell, you ensure that it’s not possible to log in as tomcat.

To install Tomcat, you’ll need the latest Core Linux build for Tomcat 10, which you can get from the downloads page.

Select the latest Core Linux build, ending in .tar.gz

Copy the downloaded file to the /tmp directory.

Navigate to the /tmp directory:

Then, extract the archive you downloaded by running:

Since you have already created a user, you can now grant Tomcat ownership over the extracted installation by running:

Configuring Admin Users

To gain access to the Manager and Host Manager pages, you’ll define privileged users in Tomcat’s configuration. You will need to remove the IP address restrictions, which disallows all external IP addresses from accessing those pages.

Tomcat users are defined in /opt/tomcat/conf/tomcat-users.xml. Open the following file for editing…

… and add the following lines before the ending tag:

Replace the manager_password and admin_password passwords with your own. When you’re done, save and close the file.

Here you define two user roles, manager-gui and admin-gui, which allow access to Manager and Host Manager pages, respectively. You also define two users, manager and admin, with relevant roles.

By default, Tomcat is configured to restrict access to the admin pages, unless the connection comes from the server itself. To access those pages with the users you just defined, you will need to edit config files for those pages. It is not recommended to do this as it may provide a security risk.

To remove the restriction for the Manager page, open the following two config files for editing:

Comment out the following in each file:

Creating a System Service

The systemd service that you will now create will keep Tomcat quietly running in the background. The systemd service will also restart Tomcat automatically in case of an error or failure.

Tomcat, being a Java application itself, requires the Java runtime to be present, which you installed with the JDK in step 1. Before you create the service, you need to know where Java is located. You can look that up by running the following command:

The output will be similar to this:

Note the path where Java resides, listed in the last column. You’ll need the path momentarily to define the service.

You’ll store the tomcat service in a file named tomcat.service, under /etc/systemd/system. Create the file for editing using the following commands

Paste the following contents into the file:

When you’re done, save and close the file.

Reload the systemd daemon so that it becomes aware of the new service:

You can then start the Tomcat service by typing:

Then, look at its status to confirm that it started successfully:

You should see something like this:

To enable Tomcat to start up with the system, run the following command:

Now that the Tomcat service is running, you can configure the firewall to allow connections to Tomcat. Then, you will be able to access its web Interface.

Tomcat uses port 8080 to accept HTTP requests.

Determine the IP of the server and access the Tomcat Console with:

Step 3: Deployment of the eiPlatform WAR into Tomcat

• Download the eip.war from the PilotFish Customer Portal
  You can login to the customer portal with your eiConsole license credentials. If you don’t have credentials or do not see the needed eip.war file, reach out to support@pilotfishtechnology.com for assistance.
• It will be named something like eip.war.hs.23R1.127. Rename it to eip.war.
• Navigate to the Tomcat installation directory and select the webapps subdirectory. The eip.war file should be copied into that directory.
  /opt/tomcat/webapps
• Copy your pflicense file into the webapps\eip folder.
  You can login to the customer portal with your eiConsole license credentials and download it. If you don’t have credentials or do not see the pflicense, reach out to support@pilotfishtechnology.com for assistance
• Restart Tomcat using the instructions below.
  How to start and stop the Tomcat service:
  sudo systemctl start tomcat
sudo systemctl stop tomcat
• Go to the logs /opt/tomcat/webapps/eip/logs where the eip.log file is at and then review and confirm there are no startup errors.