Skip to main content

Custom Branding / Whitelabeling

tip

This article describes a use case available to Pomerium Enterprise customers.

Pomerium's user and administrative facing GUI and error messages can be customized to meet your organization's needs.

Settings

Most of the Branding settings are located in the Branding Tab of the main Settings Page.

Branding Settings in Pomerium Enterprise

There is also a setting to enable Error Details on Edit Route's General Tab.

Enable Error Details on a Route

Policies have two new fields, explanation and remediation.

Explanation is an optional short description of why the user would have been denied. Likewise, remediation is an optional field to cover how the user can self-remediate their state. Oftentimes, this will be a link to your internal help desk support site or knowledge base repo.

Add custom error messages.

Colors

Adding a hex code to the Primary Color setting will affect the majority of the theming on the console. For more details on how the types of colors will impact the look and feel of Pomerium, see Material Designs' color documentation's color documentation.

Primary Color Pomerium Enterprise

There is also a secondary color that is used for a few things such as certain button colors.

Secondary Color Pomerium Enterprise

Choosing colors also affects the majority of webpages served by Pomerium Core.

Error Pages and User Info

You can also set different colors for users using dark mode.

Dark Mode Colors

You may add a URL to link to your logo and favicon which will replace the Pomerium defaults.

Replace the Logo and Favicon in Pomerium Enterprise

It will also appear for all the user-facing webpages too.

Replace the Logo and Favicon in Open Source webpages

Error Details

It is possible to customize the error messages displayed on 403 unauthorized pages.

This feature is enabled on a per Route basis by toggling the setting in the General Tab of the Route settings.

Enable Error Details

Error Message will appear similar to this example.

Extra Error Details

Policies without an explanation or remediation field will show the policy ID.

If the explanation or remediation fields are added to the policy they will show up in the error details.

Policy Settings

You can additionally add a Header paragraph that supports markdown to all error pages in the General Settings (same place you add colors and logos).

Markdown Header

You can see the link added to the Error Page.

Markdown Header