Controlling PoolParty

27/02/2026

The method of how to start, stop, or restart PoolParty is dependent on the method with which PoolParty was installed.

Preliminary Steps

Log in to a shell on the PoolParty host.
Navigate to the directory containing your PoolParty configuration files (e.g., your Docker Compose file).
Note
The commands below may require elevated permissions. If you are not logged in as root, prefix the commands with sudo (for example, sudo docker compose stop).
Enter the command for the action you want to be performed.

If PoolParty was started using the script located in the /bin directory, it runs as a standard system process.

For example, the method for stopping PoolParty depends on whether it is running in your active terminal session or in the background as a daemon.

Running in the foreground: If you ran the script and the logs are currently scrolling in your terminal window, simply press Ctrl + C. This sends an interrupt signal to the process, allowing it to shut down gracefully.
Running in the background: If PoolParty is running in the background, you must identify its Process ID (PID) and then use kill <PID>.
Tip
Run the following command to find the PID of the PoolParty process:
```
ps aux | grep poolparty
```
If the application is frozen or won't stop with the kill command, use the -9 flag (kill -9 <PID>).
Warning
Use this flag only as a last resort, as it prevents the application from performing a clean shutdown.

Since PoolParty release 3.1.0, the PoolParty control script supports a debugging mode that produces detailed output of system actions at runtime. You can enable this either via a command-line flag or by modifying the configuration file.

Method 1: Command Line (One-time)

To start PoolParty with debug logging immediately, include the -Dpoolparty.logger.root.level=DEBUG property when invoking the script. Use the following command structure:

/usr/share/poolparty/bin/poolparty -Dpoolparty.logger.root.level=DEBUG /usr/share/poolparty/

Method 2: Configuration File (Persistent)

If you want debugging to remain active across restarts without typing a long command, you can update the configuration properties by adding the following:

poolparty.logger.root.level=DEBUG

In this section:

Controlling PoolParty

Note

Tip

Warning

Method 1: Command Line (One-time)

Method 2: Configuration File (Persistent)