Fresh PoolParty Installation

16/09/2025

Unpack the {compressed_PoolParty_file_name}.tar.gz file. Unpacking this file will create a folder called ENV_PATH_POOLPARTY_INSTALLATION/poolparty_setup containing all required files.
```
tar -xf {compressed_PoolParty_file_name}.tar.gz
```

Change the directory.
```
cd poolparty_setup
```

Now you will fine tune the .env file to match your target server configuration. Remember to adjust non-mandatory parameters if this is required for a certain component.

We are using the the vi editor to modify the .env file content:

vi .env

Example of the .env file for an on-premise installation on a Linux server

poolparty@/opt/poolparty/poolparty_setup$ cat .env 
ENV_PATH_POOLPARTY_INSTALLATION="/opt/poolparty"
ENV_PATH_POOLPARTY_DATA="/opt/poolparty/data"
ENV_USER="poolparty"
ENV_GROUP="poolparty"
ENV_URL_POOLPARTY_BASE_SCHEME="httpscheme.server.com”
ENV_URL_POOLPARTY_BASE_VOCABULARY="vocabulary.server.com"
ENV_URL_POOLPARTY_BASE_CONTEXT="data.server.com"
ENV_URL_POOLPARTY_BASE_USER="resource.server.com/user"
ENV_PORT_POOLPARTY_TOMCAT="8081"
ENV_URL_KEYCLOAK="server.com/auth"

Start the installation.

Run the .setup.sh script.
```
./setup.sh
```
If all the mandatory variables set in the .env file were correct, installation will complete without any interaction from you.
Note
If this file contains an error or a typo for instance, the installation will be aborted. To see why the installation process has been aborted open the log file where you find all details required to make any corrections to the respective entry in the .env file.

After successful completion of the installation process you will see all the credentials printed on the screen:

/opt/poolparty/poolparty_setup$ ./setup.sh
[ Note ] PoolParty installation script for version 9.5.0 has started.
[ Note ] Input validation and system checks have been completed.
[ Note ] Files and folders have been copied to the specified target directories.
[ Note ] Placeholder values in configuration files have been updated with the provided input (.env file).
[ Note ] Keycloak has been successfully set up.
[ Note ] Elasticsearch has been successfully set up.

[ Note ] Authentication service admin credentials: poolparty_auth_admin/password
[ Note ] Superadmin credentials: superadmin/password 
[ Note ] Elasticsearch credentials: elastic/password

[ Note ] Running PoolParty with root user privileges is not recommended.

The installation logs are located in the following directory: ENV_PATH_POOLPARTY_INSTALLATION/poolparty_setup/pp-installation.log.

Then obtain the PoolParty license file and add it to the license directory {repository.server}/config/licenses. The default setting for the license directory is ENV_PATH_POOLPARTY_INSTALLATION/config/licenses.

Start the PoolParty by executing the start command from the ENV_PATH_POOLPARTY_INSTALLATION/bin folder.
```
./poolparty start
```

Check that the application is up.

tail -f /opt/poolparty/tomcat/logs/catalina.out

The following should appear at the end of the log:

INFO [main] org.apache.catalina.startup.Catalina.start Server startup in [121433] milliseconds

If everything is fine, you can delete the PoolParty installation files from the poolparty_setup directory and the *.tar installer.
Tip
It is recommendable to keep a copy of the .env file for reference.

In this section: