Admin Console Environment Warning

Since Payara Server 172

When working with multiple shared environments, it is common for restrictions to be in place on what modifications can be allowed for a given domain. For example, the test environment cannot deviate significantly from the target production environment without potentially invalidating the test.

One way to ensure no accidental changes are made would be to revoke access to the admin console, but this has the downside of preventing engineers from seeing the current settings in the event that a bug is found.

As an alternative, Payara Server now ships with a configurable warning bar to ensure any user will see a warning message in while viewing the console:

Payara Server 172 Environment Warning screenshot

The warning can be configured in the admin console as seen in the screenshot above. There is a new "Environment Warning" tab in the "Domain" section which allows you to configure the text and colours of the warning message.

Configuring the Environment Warning via Asadmin

There are corresponding asadmin commands to get and set the configuration


Usage: asadmin> set-environment-warning-configuration --enabled=true --message="Caution, this is on production" --textcolour="#00ff00" --backgroundcolour="#ff00ff"

Aim: Sets the environment warning properties and can enable/disable the warning


Usage: asadmin> get-environment-warning-configuration

Aim: Gets the current environment warning configuration

Enabled  Message                         Background Colour  Text Colour
true     Caution, this is on production  #ff00ff            #00ff00
Command get-environment-warning-configuration executed successfully.

Command Options

Option Type Description Default Mandatory



If it is set to true, the top warning banner is shown, otherwise it is not.





Text message for the top warning banner.




Hex colour code

Background colour for the top warning banner. It must be a hex value, like #ffffff.




Hex colour code

Text colour for the top warning banner. It must be a hex value, like #ffffff.



results matching ""

    No results matching ""