Skip to main content

Installing Constellation by using Docker

Suggest edit
Updated on February 2, 2022
Applicable to Cosmos React and Theme Cosmos applications

Explore the latest React-based run-time environment, which improves performance and responsiveness, and offers a revised set of user-friendly tools for authoring views and portals. You can use Docker to install the Constellation engine framework in your on-premises development environment.

Note: You do not have to install Constellation manually if your environment meets any of the following criteria:
  • Pega Platform is hosted on Pega Cloud services.
  • Pega Platform is hosted on a client-managed cloud environment.
  • Constellation was installed with Pega Infinity.
  • If you are an internal Pega user.
In such cases, the Constellation engine is already a part of your development environment, and you only need to enable the framework for your applications.
Before you begin: Prepare for the installation:
  1. Log in to Pega's Docker repository.For example:
    docker login
  2. In a terminal window, pull the Constellation container by entering docker pull
  3. Start the service by entering docker run -v /<path to folder with key certificate>:/host_folder -p 3443:3443 --name <container name> httpsKey=<SSL key> httpsCert=<SSL certificate> urlPath=<service URL path> port=3443 logLevel=info
    The variables have the following values:<path to folder with key certificate> is the absolute path to the local folder that contains the HTTPS key file and the certificate file.<container name> is the name of the Docker container.<SSL key> is the name of the key file.<SSL certificate> is the name of the certificate file.<service URL path> is the URL path on which the service is deployed. The path must match the load balancer or router traffic routing.
    For example: docker run -p 3443:3443 -v /usr/abc/certs:/host_folder --name constellation-service port=3443 urlPath=/c11n httpsKey=afile.key httpsCert=bfile.cert logLevel=info
    Note: When you deploy behind a load balancer, the load balancer usually holds the SSL certificate. In this case, you do not need to add the certificate at this point.
For example: For multiple containers, you can use a Docker compose file similar to the following example:

# sample compose file to show use of Constellation Static Service
# host_folder  needs to be mapped to the host folder containing the ssl cert and key files
# docker-compose -f docker-compose.yml up / docker-compose -f docker-compose.yml down -v

version: "3.2"


    image: ""
    - "3443:3443"
      - /Users/johnn/ssl-cert:/host_folder
    command:  httpsKey=tomcat.key httpsCert=tomcat.cer info
  • Previous topic Constellation service, deployment, and network configuration
  • Next topic Configuring Docker authentication
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us