PoolParty 10.0 Installation Guide

16/09/2025

This guide shows how to do a fresh installation of PoolParty 10 for both development and production environments.

Note

If you already have PoolParty 9 installed, consult the PoolParty 9.7 to 10 Migration Guide instead of this one. If you are installing a clean new version of PoolParty 10 instead of upgrading but using existing Keycloak, Elasticsearch, or Spark instances, the Migration Guide has helpful information for that.

The most up-to-date version of these instructions is available in the github compose-files project's README.md file, titled Docker compose file for PoolParty. This document will help you navigate the README to find what you need.

PoolParty uses Docker to automate the installation of the configured set of components that make up PoolParty. These components include Keycloak, Elasticsearch, Spark, Nginx, and GraphDB.

You can perform this installation from the Linux command line or, using the Docker Desktop, on macOS or Windows.

A minimum of 32GB of memory (8 for PoolParty, 12 for Elasticsearch, and 12 for GraphDB); we recommend 44 GB (16 for PoolParty, 16 for Elasticsearch, and 12 for GraphDB)
A downloaded copy of the compose-files github project, which contains the README file mentioned above and other files that you will use as part of the installation
A recent version of Docker or Docker Desktop
The docker-compose-plugin, which is installed with the other Docker packages when you install Docker with the instructions on the Docker site
License files for PoolParty and GraphDB

From a high level, installation of PoolParty consists of three steps:

Copying the .env_template file included with the github project to a .env file that you will use to customize your installation
Setting appropriate environment variables in the .env file, and possibly other values in other configuration files
Running a Docker command that uses the downloaded Docker image and configuration settings to install and then start PoolParty

Configuration file settings vary depending on your deployment requirements. For development environments intended for internal use only, you can use the default settings with included Docker instances. Production environments, however, typically require integration with existing external services such as PostgreSQL, Keycloak, and Spark rather than relying on the bundled Docker instances.

The configuration section of the README file describes how you must copy the .env_template file included with the github project to a .env file. This file is where you will set environment variables for Docker to use when it installs the image. Two especially important variables described by the README file are POOLPARTY_LICENSE and GRAPHDB_LICENSE , which must be set for your PoolParty instance to find the appropriate licenses.

The README file also lists several other administration passwords that are useful to set. Comments in the .env file describe dozens of other environment variables that you can set to customize your developer or production environment.

The following shows an example .env_template file with all of the potential settings and comments about their roles. (Be sure to use the version of this file included with the compose-files github project mentioned above under Prerequisites to ensure that you have the most recent version.)

The introduction to the Docker compose file for PoolParty README file describes additional configuration files with settings that you can use to, for example, add additional services or include SSL support. (For more details on running PoolParty with SSL support, see the Running with SLL section of the README file, which describes the .env variables to set to point to your SSL certificate and key and also the ssl.yaml file that is included with the github project to use with the docker compose command.)

The introduction to the README file also describes the Docker commands used to start up or shut down services. For a simple development environment PoolParty setup, the startup command may be as simple as this:

docker compose up -d

As this runs, it will display messages as it starts the various services. When complete, it will return to your command line prompt.

Note

When running the installation, the error message "Bind for 0.0.0.0:nn failed: port is already allocated" (where nn is a port number), means that the Docker installation process is trying to assign something to a port that is already used by another service. Use the appropriate operating system tool to find which service is using that port. If you can't unset that one, you can change the port being used by PoolParty in the docker-compose.yaml file.

You can add additional configuration files on the docker compose command line. For example, the following uses the production.yaml file included with the github compose-files project to add in the PostgreSQL service used by Keycloak:

docker compose -f docker-compose.yaml -f production.yaml up -d

Note

To learn more about running a development configuration of PoolParty without Keycloak, see the Development section of the README file.

You can configure the use of an external Spark service by by adding the spark.yaml file from the github project to the command line with appropriate settings:

docker compose up -f docker-compose.yaml -f spark.yaml up -d

Once the docker compose up command finishes, you can confirm that you have installed PoolParty by sending your browser to http://poolparty.127.0.0.1.nip.io/PoolParty, which will display this:

Note

nip.io is used here because it's an easy DNS service to use for demos like this. For anything else other then local development or testing, you would need a real DNS name that resolves to the machine where PoolParty is deployed.

On the screen shown above, log in with the user name superadmin and the password poolparty. Once you log in, it will have you create a new password.

In this section: