Install the Platform admin UI for standalone IDM
| To use any IDM UI in a production environment, it must only be accessed in an HTTPS context. You can accomplish this using a separate server (such as an SSL-terminating reverse proxy) or directly configuring the web server hosting the UI files to support HTTPS. The specific implementation choice for using HTTPS is outside the scope of this documentation. |
The Platform admin UI is the replacement for the deprecated legacy admin UI. Starting with IDM 8.1, it ships as a separate downloadable artifact from the Backstage download site, and is not bundled with the IDM .zip.
You can deploy the Platform admin UI in either of two ways from the same artifact:
-
Behind a standalone Nginx server.
-
As a Docker container you build from the included
Dockerfile.
|
The Platform admin UI and the legacy admin UI are independent artifacts. You can install one or both on different Nginx servers or different ports. New deployments should use the Platform admin UI. |
Before you begin
-
IDM 8.1 or later, running and reachable from the host that serves the UI.
-
For the Nginx path: Nginx 1.18 or later.
-
For the Docker path: Docker 20.10 or later.
Download and extract the artifact
-
Download the Platform admin UI artifact (
PingIDM-Admin-UI-8.1.1.zip) from the Backstage download site. -
Extract the
.ziparchive to a working directory:unzip ~/Downloads/PingIDM-Admin-UI-8.1.1.zip -d ~/Downloads/tmpThe archive contains the following structure:
IDMAdminUI/ ├── www/ │ └── platform/ # Production build output ├── Dockerfile # Production image (Nginx + Alpine) ├── nginx.conf # Example config for standalone Nginx ├── nginx.docker.conf # Example config for Docker ├── entrypoint.sh # Container entrypoint ├── variable_replacement.sh # envsubst script for static assets └── DEPLOYMENT.md
Install behind a standalone Nginx server
Use this path when you want to serve the UI directly from Nginx without Docker.
Consult the Nginx documentation for your operating system, as you might need to adjust the instructions in this overview. Examples include nesting the server block inside the http block of your main /etc/nginx/nginx.conf or placing nginx.conf as a standalone file in /etc/nginx/conf.d/.
-
Change to the extracted directory:
cd ~/Downloads/tmp/IDMAdminUI -
Set the environment variables for your deployment. The
variable_replacement.shscript substitutes these values into the compiled JavaScript bundles. The following defaults assume IDM is reachable through the same Nginx host:export IDM_REST_URL=/openidm export IDM_UPLOAD_URL=/upload export IDM_EXPORT_URL=/export export MENUS_FILE=menus.idm export ROUTES_FILE=routes.idm export DEPLOYMENT_TYPE=IDM export ENABLE_WORKFORCE=false export AM_URL= export AM_ADMIN_URL=For the full list of supported variables and defaults, refer to Environment variables reference.
-
Run the variable replacement script against the compiled JavaScript:
./variable_replacement.sh www/platform/js/*.js -
Install Nginx using the package manager for your operating system. For example:
-
Debian/Ubuntu
-
RHEL/CentOS/Fedora
sudo apt update sudo apt install nginxsudo yum install nginx -
-
Copy the UI assets into the Nginx
htmlwebroot:cp -r www/platform /usr/share/nginx/html/The default Nginx webroot varies by distribution (commonly /usr/share/nginx/htmlor/var/www/html). -
Edit the
nginx.conffile from the extracted archive:-
Update the
rootdirective to point to your Nginx webroot. For example,/usr/share/nginx/html. -
Update the
proxy_passdirective to point to your IDM instance. For example,http://localhost:8080/openidm.
Examplenginx.confexcerpt... server { listen 8082; (1) server_name localhost; root /usr/share/nginx/html; ... location /openidm { proxy_pass http://localhost:8080/openidm; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header X-Forwarded-Proto $scheme; } }1 The server listens on port 8082to avoid conflicts with IDM, which typically runs on port8080. -
-
Copy the modified
nginx.confto the Nginx configuration directory:cp ~/Downloads/tmp/IDMAdminUI/nginx.conf /etc/nginx/nginx.confIf you’re already using Nginx for other site configurations, don’t overwrite your existing nginx.conf. Read about managing Nginx configuration files for guidance on integrating additional server blocks into your existing setup. -
Test the modified
nginx.confconfiguration for syntax errors:nginx -t nginx: the configuration file /etc/nginx/nginx.conf syntax is ok nginx: configuration file /etc/nginx/nginx.conf test is successful -
Restart Nginx:
systemctl restart nginx
Install with Docker
Use this path when you want to run the UI as a container. The included Dockerfile produces a production image based on nginxinc/nginx-unprivileged.
You can download Docker from the official Docker homepage.
-
Change to the extracted directory:
cd ~/Downloads/tmp/IDMAdminUI -
From the extracted archive, build the image.
The
Dockerfileaccepts two optional build arguments:Argument Default Description WEB_ROOT_LOCATIONwww/platformPath to the built UI assets
NGINX_CONFnginx.docker.confServer block config to copy into the image.
-
Build without arguments
-
Build with arguments
docker build -t platform-admin-ui:latest .docker build \ --build-arg WEB_ROOT_LOCATION=my/assets \ --build-arg NGINX_CONF=my-nginx.conf \ -t platform-admin-ui:latest . -
-
Run the container, passing your environment variables as
-eflags. For the full list of supported variables and defaults, refer to Environment variables reference.docker run -d --name idm-admin -p 8082:8080 \ -e IDM_REST_URL="/openidm" \ -e IDM_UPLOAD_URL="/upload" \ -e IDM_EXPORT_URL="/export" \ -e MENUS_FILE="menus.idm" \ -e ROUTES_FILE="routes.idm" \ -e DEPLOYMENT_TYPE="IDM" \ -e ENABLE_WORKFORCE="false" \ -e AM_URL="" \ -e AM_ADMIN_URL="" \ platform-admin-ui:latestThe Docker entrypoint runs
variable_replacement.shagainst the compiled bundles before starting Nginx, so the UI picks up your runtime values without rebuilding the image. -
To use your own Nginx server block instead of the one built into the image, mount it over
default.confat runtime:docker run -d -p 8082:8080 \ -v /path/to/my-nginx.conf:/etc/nginx/conf.d/default.conf:ro \ platform-admin-ui:latest
Access the Platform admin UI
With IDM running, go to the Nginx host and port you configured. For the defaults shown previously, the UI is available at:
http://localhost:8082/platform
Configure the Platform admin UI for a generic OIDC provider
By default, the Platform admin UI authenticates against PingAM. If you’re running IDM in standalone mode, you can configure the UI to authenticate through any OpenID Connect (OIDC) provider that supports the authorization code flow with Proof Key for Code Exchange (PKCE). For example, PingOne’s PKCE enforcement settings.
The Platform admin UI acts as a public OIDC client and performs an authorization code flow with PKCE against your provider. This is a separate configuration from the IDM-side token validation. Learn more in Authenticate through a generic OIDC provider.
This section uses PingOne as an example to set up an OIDC web application and a user. You can substitute the equivalent settings from your own OIDC provider.
|
Before you begin, configure the |
-
In PingOne, create an OIDC Web App application. This application is distinct from the resource used for token introspection on the IDM side.
-
Set the Token Endpoint Authentication Method to None.
-
Add your local UI to the Redirect URIs field and enable the Allow Redirect URI Patterns checkbox. This lets you use a wildcard pattern in the redirect URI, for example,
http://localhost:8082/*. Learn more about Redirect URIs.Reserve wildcard patterns for local testing only. For production and other non-local deployments, register the exact redirect URI instead.
-
Add the resource you created when you set up PingOne to the web application you created in step 1.
-
Create a user in PingOne. This is the user who signs on to the Platform admin UI. Make sure it matches the identity you mapped in
staticUserMappingin Configure the rsFilter. -
Collect the following values from your PingOne application:
Value PingOne Value Client IDThe application’s Client ID
Authorization endpoint
The application’s Authorization URL
Token endpoint
The application’s Token Endpoint
Revocation endpoint
The application’s Token Revocation Endpoint
End-session endpoint
The application’s Signoff Endpoint
Learn more in Configuring web applications.
-
Set the corresponding environment variables described in Environment variables reference:
ADMIN_CLIENT_ID,AUTHORIZATION_ENDPOINT,TOKEN_ENDPOINT,REVOCATION_ENDPOINT, andEND_SESSION_ENDPOINT.
Environment variables reference
The entrypoint passes every variable in the following table through envsubst and into the compiled JavaScript bundles. Build the image (or extract the artifact) once, then configure per environment.
| Variable | Default | Description |
|---|---|---|
|
|
IDM REST API URL |
|
|
IDM upload URL |
|
|
IDM export URL |
|
|
IDM menus file |
|
|
IDM routes file |
|
|
Deployment type. Leave set to |
|
|
Workforce features. Leave |
|
(empty) |
PingAM URL. Leave blank for standalone IDM. |
|
(empty) |
PingAM admin URL. Leave blank for standalone IDM. |
|
(empty) |
Client ID of the OIDC public client used for PKCE authentication.[1] |
|
(empty) |
Authorization endpoint of the OIDC provider.[1] |
|
(empty) |
Token endpoint of the OIDC provider.[1] |
|
(empty) |
Token revocation endpoint of the OIDC provider.[1] |
|
(empty) |
End-session (logout) endpoint of the OIDC provider.[1] |