Installing the Docker container with React UI

Test the latest run-time functionalities by installing React UI. To deploy the React UI framework to your on-premises development environment, install the Docker container.

Note: If you use Pega Cloud Services or a client-managed cloud environment to host your Pega Platform, the React UI engine is already a part of your development environment, and you only need to enable it for your applications. For more information, see Testing React UI for an application.

Before you begin: Prepare installation tools:

Ensure that you have the Docker command line interface installed on-premises.
Contact Pega for access to a repository with the React UI container.

Install the React UI service:

Choices Actions

Manual installation

Choices	Actions
Manual installation	In a terminal window, pull the React UI container by entering: `docker pull <repository address>` Install the service by entering `docker run -p <host port>:<container port> --name <container name> <repository address> port=<port number> infinity=<Infinity URL> <log type>` For example: `docker run -p 3000:3000 --name constellation-service meshbincam.pega.com:7000/constellationui/service port=3000 infinity=http://192.168.1.2:1080/prweb/ info`
Docker compose	Create a Docker compose file with the following content: `version: "3.2" services: c11n-svce: image: "<repository address>" ports: - "<host port>:<container port>" command: "port=<port number> <Infinity URL> sync=true <log type>"` Save the file to your local system. In a terminal window, enter `docker-compose -f <file name> up / down`

In a terminal window, pull the React UI container by entering: docker pull <repository address>
Install the service by entering docker run -p <host port>:<container port> --name <container name> <repository address> port=<port number> infinity=<Infinity URL> <log type>
For example: docker run -p 3000:3000 --name constellation-service meshbincam.pega.com:7000/constellationui/service port=3000 infinity=http://192.168.1.2:1080/prweb/ info

Docker compose

Create a Docker compose file with the following content:

version: "3.2"
 
services:
 
  c11n-svce:
    image: "<repository address>"
    ports:
    - "<host port>:<container port>"
    command:  "port=<port number> <Infinity URL> sync=true <log type>"

Save the file to your local system.
In a terminal window, enter docker-compose -f <file name> up / down

The variables have the following values:

<container name> is the name of the Docker container.
<container port> is the port number of the container.
<file name> is the name of the Docker compose file.
<host port> is the port number of the host.
<Infinity URL> is the URL address of the Infinity service that REST calls. This could be either a load balancer, or a back-end service address. The HTTPS protocol is the default.
<log type> is the type of log that the build produces.
<port number> is the number of the port on which the React UI listens. The number must match the <container port>.
<repository address> is the address of the repository that includes the container.

What to do next: Configure your Pega Platform to use React UI. For more information, see Configuring Pega Platform for React UI.