En

Installing Sherpa Process Discovery#

The standard Sherpa PD Server client distribution is installed on a Linux server with Docker Compose. Obtain the client bundle and image archives for one version from the vendor. For an offline installation, transfer all archives to the target server in advance, including pd-labeling-service_*.tar.gz. See bundle contents and download examples.

Before you start#

  1. Install Docker with the Compose plugin and verify docker --version and docker compose version.
  2. Extract docker_pd_client_files_*.tgz into a separate directory. It should contain sh_scripts/install.sh, a compose file, a .env template, and configuration directories.
  3. Check available disk space for archives, loaded images, and PostgreSQL/ClickHouse data. Prepare the server DNS name, IP address, and certificate and key if you use your own TLS certificate.
  4. For an offline installation, place the image archives in the root of the extracted bundle. If the download server is accessible, the installer may offer to download missing archives.

Installation#

Run the following command from the root of the extracted bundle:

sudo ./sh_scripts/install.sh

The wizard checks the environment, creates the configuration, finds and loads Docker images, requests .env settings, and configures the certificate. For your own certificate, place pd.crt and pd.key in ./nginx/config/certs/ when the wizard prompts you. After showing a summary, the wizard offers to start the containers. If you postpone startup, run docker compose up -d from the same directory.

Verification#

Check docker compose ps: the application services, PostgreSQL, ClickHouse, RabbitMQ, graph-service, and labeling-service should be running. Open https://<server-name>/ in a browser. Use curl -Ik https://<server-name>/ to diagnose the response. If a container did not start, check docker compose logs <service-name> and whether its image archive is present.

Ports and connection directions are described in Network Configuration. Install Discovery Agent on workstations separately after the server is running.