Skip to main content

Installation Guide (Microsoft Windows)

Introduction

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

Keycloak

PoolParty comes with Keycloak as an authentication and authorization service. A relational database is recommended to run Keycloak. Keycloak comes with H2 as an embedded database.

Important

In accordance with the Keycloak documentation, we recommend using a proper database service instead of the default database Keycloak comes with. For more information on how to migrate to a proper database service, refer to the Keycloak documentation,

Prerequisites

To install PoolParty on Microsoft Windows, you need to:

  • Have a valid PoolParty licence.

  • Install OpenJDK.

  • Configure JAVA_HOME. It is mandatory. For a successful installation, you should be able to see the results of echo %JAVA_HOME% and java -version.

    51735504.png

  • Download the PoolParty installer (poolparty.zip) from our download area .

Installation Procedure

To install PoolParty:

Step 1: Start the PoolParty Installation

To start the installation:

  1. Create the drive:\poolpartyhome folder e.g. C:\opt\poolparty.

    The installation path should not contain any spaces.

  2. Unzip the installer in the drive:\poolpartyhome folder.

  3. Open the Command Prompt with administrator privileges.

  4. Change the directory to drive:\poolpartyhome.

  5. Go to the bin folder.

  6. Execute init_poolparty.bat file from the bin folder in the Command Prompt.

    For example, we have installed PoolParty in C:\opt\poolparty folder and we have run the init_poolparty.bat file from here.

Step 2: Define the baseURI

Define the baseURI after invoking the init_poolparty.bat file:

  1. Define the baseURI. The default is http://localhost . Either enter a custom baseURI or press Enter for the default one.

    Note

    We recommend choosing a baseURI pattern according to the planned URI Pattern Strategy Planning. Changing the baseURI pattern might imply changes to the existing data.

  2. Define the baseURI for the PoolParty projects. The default is http://localhost.

    Enter the baseURI you want to use or press Enter to use the default baseURI.

  3. Define the baseURI for users.

    Enter the baseURI you want to use or select Enter to use the default baseURI .

  4. Wait for installation to finish.

    Testing_Installation_screenshot-2.png

Step 3: Provide the PoolParty license

Provide the PoolParty licence key during login to PoolParty or place it in drive:\poolpartyhome\config\licenses folder.

Step 4: Start Services

  1. Open the management console services.msc.

  2. Navigate to the PoolParty Services.

    1. Start Keycloak.

    2. Start Solr.

    3. Start Tomcat.

    Screenshot_from_2022-10-24_10-38-11.png
In this section: