Installation Guide (Linux)

Introduction

Make sure that you have followed the prerequisites defined in the PoolParty System Requirements.

Prerequisites

The following prerequisites must be satisfied to be able to install PoolParty on a Linux system:

Installation Procedure

STEP 1: Open the terminal and run there the installer PoolParty.run. At first you will be prompted that PoolParty will be installed on your system. To confirm press either o or Enter. If you want to cancel the installation press c. The installation routine for the version 9.4.1 looks as follows;

This will install PoolParty 9.4.2 on your computer.
[ Note ] You've started this installer unprivilileged.
[ Note ] Make sure to have read/write access in your dedicated installation directgory.

OK [o, Enter], Cancel [c]


Choose the appropriate option:
Install PoolParty [1, Enter]
Upgrade an existing PoolParty installation [2],
Cancel installation [c]
> 1

Where should PoolParty be installed
[/home/poolparty/poolparty]
> /opt/poolparty

Default location for PoolParty data:
[/home/poolparty/poolparty/data]
> /opt/poolparty/data

Base URL for custom schemes and ontologies:
[http://localhost]
> https://poolparty.example.org

Base URL for projects:
[https://poolparty.example.org]
>

Base URL for users:
[https://poolparty.example.org/user]
>

Default PoolParty http Port :
[8081]
>

Default PoolParty authentication service url:
[https://poolparty.example.org:8181/auth]
>

STEP 2: Start a new installation by either entering 1 or pressing Enter.

STEP 3: Now you are prompted to specify the installation directory for both the PoolParty Application Directory (PPAppDir) and PoolParty Data Directory (PPDataDir).

You can define the path of your PoolParty directory structure on your Linux system .The default setting for PPAppDir is /opt/poolparty. If you want to use the default path, simply press Enter, otherwise enter the desired path and confirm with Enter. The default directory for PPDataDir is /opt/poolparty/data. To use the default path, simply press Enter, otherwise enter the desired directory path and confirm with Enter.

STEP 4: Define a User and Group

Now you need to specify the user owning the installation directory; the default setting is poolparty. You can of course enter the desired user or use the default user. To confirm the name of the user press Enter. Then you need to define the group that will be running the PoolParty application; again the default group name is poolparty; you can either confirm the default group name with Enter or enter the desired group name and press Enter.

STEP 5: Adjust the Base URIs.

In this step you can define the base URIs used in PoolParty per default to create projects, ontologies and custom schemes, or users.

Now you will have to specify the base URL for custom schemes and ontologies. The default value is http://localhost, but we recommend using a meaningful name such as https://poolparty.example.org). Confirm the specified URI by pressing Enter. Continue with specifying the base URLs for projects (default: http://localhost respectively the URL specified for custom schemes and ontologies - e.g. https://poolparty.example.org), users (default: http://localhost/users).

STEP 6: Miscellaneous Settings

Specify the Servlet PoolParty port; the default value for the http port is 8081.

Then enter the location of the PoolParty authentication service; the default is https://localhost:8181/auth.

Now you only need to specify the index service to be used by PoolParty - either Solr or Elasticsearch. The default setting is Solr.

You confirm these settings by pressing Enter.

STEP 7: Finalize the Installation.

Now you are presented with an overview of all the settings you have just made. Press Enter to complete the installation. Next the credentials for the Tomcat Web Application Manager will be displayed along with some additional details on the installation process.

STEP 8: Move Your License Keys to the License Directory

Add your license keys to the license directory <PPAppDir>/config/licenses.

The default setting for the license directory is /opt/poolparty/config/licenses.

STEP 9: Start PoolParty

Open a console and change to the poolparty user using the following command if needed.

sudo su poolparty

Now start PoolParty (more details available at Controlling PoolParty)

<PPAppDir>/bin/poolparty start

JAVA_HOME Configuration Files

Sometimes it may be necessary to specifically declare your JAVA_HOME parameter which is defined in the poolparty.conf file (refer to the poolparty.conf section for more details on how to set the JAVA_HOME parameter). You can also specify this parameter for Solr in the <PPAppDir>/data/solr/solrcore.properties file by inserting the same JAVA_HOME line as you did before in the poolparty.conf.

Post-Installation Tasks

Open a browser and access your PoolParty installation at http://localhost:8081/PoolParty. Consult the subsequent sections in the Administrator Guide which may be relevant for your post-installation tasks: