Skip to main content

Installation Guide (Microsoft Windows)

Make sure that your Windows server satisfies 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.

Tip

PoolParty 9.3.1 installation includes Keycloak version 22.0.5.

Note

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

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

  • a valid PoolParty license

  • a 64-bit Windows Server 2016 or 2019 system

  • OpenJDK 17 installed,

  • If you have no OpenJDK installed, then install OpenJDK 17 and correctly configure JAVA_HOME. To validate that your installation is successful, enter on the command line echo %JAVA_HOME% to display the Java version (in our case C:\jdk17), then enter java -version which then returns all the JDK version details.

windows_java_home.jpg

  • the PoolParty installer (poolparty.zip) which can be downloaded from our download area .

  • you should set up ES_JAVA_HOME variable the same way as you set up JAVA_HOME.

Installation Procedure
STEP 1: Install PoolParty including Elasticsearch Index & Recommender

  1. Create the drive:\poolpartyhome folder e.g. C:\opt\poolparty. The installation path may not contain any spaces.

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

  3. Open the Command Prompt with administrator privileges.

  4. Change directory to drive:\poolpartyhome.

  5. Go to the bin folder.

  6. On the Command Prompt execute init_poolparty.ps1 file from the bin folder. We have installed PoolParty to C:\opt\poolparty and we have run the init_poolparty.ps1 file from there. 

STEP 2: Define the baseURI

Define the baseURI after invoking the init_poolparty.ps1 file.

Note

We recommend choosing a baseURI pattern according to the defined URI Pattern Strategy Planning. Changing such pattern later might imply changes to the already created data.

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

  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 the installation process to finish.

powershell_1_setup.gif
powershell_2_setup.gif
STEP 3: Provide the PoolParty License

Provide the PoolParty license key during login to PoolParty, or place the license file in the drive:\poolpartyhome\config\licenses folder.

STEP 4: Start Services

  1. After completing Step 2 and Step 3 start Notepad.

  2. In the Notepad open the file poolpartyhome\tomcat\bin\setenv.bat.

  3. Update the memory settings to reflect your RAM configuration

  4. Now open Command Prompt and run: shutdown /r /t 0; or manually reboot your Windows system.

  5. Depending on the speed of your Windows system PoolParty should be up within 5 to 8 minutes after the reboot.

Example of RAM configuration:

win_install-9_1-003.png

Tip

You can additionally check that all required services are running. To do so, open the management console services.mcs. There navigate to the PoolParty services. If the start of these services is not set to Automatic, change those settings accordingly on the management console.

Screenshot_from_2022-10-24_10-38-11.png

Note

Solr is fully supported. PoolParty currently supports Elasticsearch 8.12.

For more information, refer to:

In this section: