--- title: Ping Identity DevOps Docker Image - pingdatasync description: This docker image includes the Ping Identity PingDataSync product binaries and associated hook scripts to create and run a PingDataSync instance. component: devops page_id: devops::docker-images/pingdatasync/README canonical_url: https://developer.pingidentity.com/devops/docker-images/pingdatasync/README.html section_ids: devops-ping-identity-devops-docker-image: Ping Identity DevOps Docker Image - pingdatasync devops-related-docker-images: Related Docker Images devops-environment-variables: Environment Variables devops-ports-exposed: Ports Exposed devops-running-a-pingdatasync-container: Running a PingDataSync container devops-docker-container-hook-scripts: Docker Container Hook Scripts --- # Ping Identity DevOps Docker Image - `pingdatasync` ## Ping Identity DevOps Docker Image - `pingdatasync` This docker image includes the Ping Identity PingDataSync product binaries and associated hook scripts to create and run a PingDataSync instance. ### Related Docker Images * `pingidentity/pingbase` - Parent Image > This image inherits inherits, and can use, Environment Variables from [pingidentity/pingbase](https://devops.pingidentity.com/docker-images/pingbase/) * `pingidentity/pingdatacommon` - Common Ping files (i.e. hook scripts) ### Environment Variables In addition to environment variables inherited from **[pingidentity/pingbase](https://devops.pingidentity.com/docker-images/pingbase/)**, the following environment `ENV` variables can be used with this image. | ENV Variable | Default | Description | | ------------------------------------------ | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | SHIM | ${SHIM} | | | IMAGE\_VERSION | ${IMAGE\_VERSION} | | | IMAGE\_GIT\_REV | ${IMAGE\_GIT\_REV} | | | DATE | ${DATE} | | | PING\_PRODUCT\_VERSION | ${VERSION} | | | TAIL\_LOG\_FILES | ${SERVER\_ROOT\_DIR}/logs/sync | Files tailed once container has started | | LICENSE\_DIR | ${PD\_LICENSE\_DIR} | PD License directory. This value is set from the pingbase docker file | | LICENSE\_FILE\_NAME | PingDirectory.lic | Name of license file | | LICENSE\_SHORT\_NAME | PD | Short name used when retrieving license from License Server | | LICENSE\_VERSION | ${LICENSE\_VERSION} | Version used when retrieving license from License Server | | PING\_PRODUCT | PingDataSync | Ping product name | | STARTUP\_COMMAND | ${SERVER\_ROOT\_DIR}/bin/start-server | The command that the entrypoint will execute in the foreground to instantiate the container | | STARTUP\_FOREGROUND\_OPTS | --nodetach | The command-line options to provide to the the startup command when the container starts with the server in the foreground. This is the normal start flow for the container | | RETRY\_TIMEOUT\_SECONDS | 180 | The default retry timeout in seconds for manage-topology and remove-defunct-server | | ADMIN\_USER\_NAME | admin | Failover administrative user | | ROOT\_USER\_PASSWORD\_FILE | | Location of file with the root user password (i.e. cn=directory manager). Defaults to /SECRETS\_DIR/root-user-password | | ADMIN\_USER\_PASSWORD\_FILE | | Location of file with the admin password, used as the password replication admin Defaults to /SECRETS\_DIR/admin-user-password | | KEYSTORE\_FILE | | Location of the keystore file containing the server certificate. If left undefined, the SECRETS\_DIR will be checked for a keystore. If that keystore does not exist, the server will generate a self-signed certificate. | | KEYSTORE\_PIN\_FILE | | Location of the pin file for the keystore defined in KEYSTORE\_FILE. You must specify a KEYSTORE\_PIN\_FILE when a KEYSTORE\_FILE is present. This value does not need to be defined when allowing the server to generate a self-signed certificate. | | KEYSTORE\_TYPE | | Format of the keystore defined in KEYSTORE\_FILE. One of "jks", "pkcs12", "pem", or "bcfks" (in FIPS mode). If not defined, the keystore format will be inferred based on the file extension of the KEYSTORE\_FILE, defaulting to "jks". | | TRUSTSTORE\_FILE | | Location of the truststore file for the server. If left undefined, the SECRETS\_DIR will be checked for a truststore. If that truststore does not exist, the server will generate a truststore, containing its own certificate. | | TRUSTSTORE\_PIN\_FILE | | Location of the pin file for the truststore defined in TRUSTSTORE\_FILE. You must specify a TRUSTSTORE\_PIN\_FILE when a TRUSTSTORE\_FILE is present. This value does not need to be defined when allowing the server to generate a truststore. | | TRUSTSTORE\_TYPE | | Format of the truststore defined in TRUSTSTORE\_FILE. One of "jks", "pkcs12", "pem", or "bcfks" (in FIPS mode). If not defined, the truststore format will be inferred based on the file extension of the TRUSTSTORE\_FILE, defaulting to "jks". | | PD\_PROFILE | ${STAGING\_DIR}/pd.profile | Directory for the profile used by the PingData manage-profile tool | | UNBOUNDID\_SKIP\_START\_PRECHECK\_NODETACH | true | Setting this variable to true speeds up server startup time by skipping an unnecessary JVM check. | | PARALLEL\_POD\_MANAGEMENT\_POLICY | false | Whether this container is running as a Pod in a Kubernetes StatefulSet, and that StatefulSet is using the Parallel podManagementPolicy. This property allows for starting up Pods in parallel to speed up the initial startup of PingDataSync topologies. This variable must be set to true when using the Parallel podManagementPolicy. Note: when using parallel startup, ensure the RETRY\_TIMEOUT\_SECONDS variable is large enough. The pods will be enabling replication simultaneously, so some pods will have to retry while waiting for others to complete. If the timeout is too low, a Pod may end up restarting unnecessarily. | | SKIP\_WAIT\_FOR\_DNS | false | Set to true to skip the waiting for DNS step that is normally done just before attempting to join the topology. | | CERTIFICATE\_NICKNAME | | There is an additional certificate-based variable used to identity the certificate alias used within the `KEYSTORE_FILE`. That variable is called `CERTIFICATE_NICKNAME`, which identifies the certificate to use by the server in the `KEYSTORE_FILE`. If a value is not provided, the container will look at the list certs found in the `KEYSTORE_FILE` and if one - and only one - certificate is found of type `PrivateKeyEntry`, that alias will be used. | | COLUMNS | 120 | Sets the number of columns in PingDataSync command-line tool output | | PD\_REBUILD\_ON\_RESTART | false | Force a rebuild (replace-profile) of PingDataSync on restart. Used to ensure that the server configuration exactly matches the server profile. This variable will slow down startup times and should only be used when necessary. | ### Ports Exposed The following ports are exposed from the container. If a variable is used, then it may come from a parent container * ${LDAP\_PORT} * ${LDAPS\_PORT} * ${HTTPS\_PORT} * ${JMX\_PORT} ### Running a PingDataSync container ```shell docker run \ --name pingdatasync \ --publish 1389:1389 \ --publish 8443:1443 \ --detach \ --env SERVER_PROFILE_URL=https://github.com/pingidentity/pingidentity-server-profiles.git \ --env SERVER_PROFILE_PATH=simple-sync/pingdatasync \ --env PING_IDENTITY_ACCEPT_EULA=YES \ --env PING_IDENTITY_DEVOPS_USER \ --env PING_IDENTITY_DEVOPS_KEY \ --tmpfs /run/secrets \ pingidentity/pingdatasync:edge ``` ### Docker Container Hook Scripts Please go [here](https://github.com/pingidentity/pingidentity-devops-getting-started/tree/master/docs/docker-images/pingdatasync/hooks/README.md) for details on all pingdatasync hook scripts *** This document is auto-generated from *[pingdatasync/Dockerfile](https://github.com/pingidentity/pingidentity-docker-builds/blob/master/pingdatasync/Dockerfile)* Copyright © 2026 Ping Identity Corporation