Broadleaf Microservices
  • v1.0.0-latest-prod

Admin Configuration Properties

The Admin configuration properties are typically found in Admin Starter’s .env file. To override the default values, a copy of the .env file should be made in the same location and renamed .env.local.

Authentication

Property Name Description Default Value

SKIP_PREFLIGHT_CHECK

Whether or not to disable CORS preflight checks.

true

VITE_AUTH_GATEWAY_DISCOVERY_URL

The URL suffix to be used in retrieving client information. Used in cases such as initializing the Authentication context or impersonating a user.

/auth/client-discovery

VITE_AUTH_IMPERSONATION_URL

The URL suffix to be used in initiating the impersonation of a given user.

/auth/impersonate

VITE_AUTH_HEADERS_AUTHORIZATION

The authorization header to be used when making requests.

Authorization

VITE_AUTH_HEADERS_AUTHORIZATION_PREFIX

The prefix for the bearer token attached to the authorization header for making requests.

Bearer

VITE_AUTH_PROVIDER_OAUTH_AUTHORIZEURL

The OAuth URL suffix for authorizing users.

/auth/oauth/authorize

VITE_AUTH_PROVIDER_OAUTH_TOKENURL

The URL suffix to retrieve an access token.

/auth/oauth/token

VITE_AUTH_PROVIDER_OAUTH_LOGINREQUIRED

Determines if login is required for Admin Client.

true

VITE_AUTH_PROVIDER_OAUTH_LOGOUTURL

The URL suffix for logging out users.

/auth/logout

VITE_AUTH_PROVIDER_OAUTH_CHANGEPASSWORDURL

The URL suffix for allowing users to change their password.

/auth/change-password

VITE_AUTH_PROVIDER_OAUTH_USERURL

The URL suffix to be used in retrieving user information.

/auth/user

VITE_AUTH_PROVIDER_OAUTH_USERSCOPE

The scope for user-related operations.

USER

VITE_AUTH_PROVIDER_OAUTH_CALLBACKURL

The URL suffix to be used for redirect callbacks.

/callback

VITE_AUTH_PROVIDER_OAUTH_SILENTCALLBACKURL

The URL suffix to be used for silent authorization callbacks.

/silent-callback.html

VITE_AUTH_PROVIDER_OAUTH_RESPONSETYPE

The OAuth response type that tells the authorization server which grant to execute.

Read more about the possible values and their uses here.

code

VITE_AUTH_PROVIDER_OAUTH_EVENTTYPE

The OAuth grant type used for silent authorization callbacks. By default only authorization_code is supported.

authorization_code

VITE_AUTH_PROVIDER_OAUTH_SILENTTIMEOUT

The amount of milliseconds before the silent authorization callback is to return a timeout error.

7000

VITE_AUTH_PROVIDER_OAUTH_HEADERS_EXPIRATION

The header from a user’s access token that determines the token’s expiration date.

exp

VITE_AUTH_PROVIDER_OAUTH_HEADERS_MAXEXPIRATION

The header from a user’s access token that determines the token’s maximum expiration date.

max

VITE_AUTH_STATE_CACHE_TTL

The default time-to-live (TTL) for elements that are cached for the Auth state — 0 means it will never expire.

0

Keep Alive Session

Property Description Default Value

VITE_SESSION_EXPIRATION_COUNTDOWN_INTERVAL

The interval at which the countdown in the session expiration modal starts.

180000

VITE_SESSION_EXPIRATION_ACTIVITY_INTERVAL

The interval at which Admin Client checks to see if activity has happened to determine if the session should be refreshed.

300000

Metadata

Property Name Description Default Value

VITE_METADATA_AUGMENTATION_SCOPE

The scope for metadata augmentation-related operations.

AUGMENTATION

VITE_METADATA_AUGMENTATION_URL

The URL suffix to be used in metadata augmentation operations, such as creating and undoing augmentations.

/metadata/augmentation

VITE_METADATA_COMPONENT_SCOPE

The scope for metadata component-related operations.

METADATA

VITE_METADATA_COMPONENT_URL

The URL suffix to be used in metadata component operations, such as fetching component metadata for a specific component by passing in the component ID.

/metadata/component/\${id}

VITE_METADATA_ROUTER_SCOPE

The scope for metadata route-related operations.

METADATA

VITE_METADATA_ROUTER_URL

The URL suffix to be used in metadata route operations, such as fetching metadata component routes.

/metadata/routes

Locales

Property Name Description Default Value

VITE_ALLOWED_LOCALES

The allowed/expected possible locales for the Admin Client.

en-US,ar-AR

Tenant Resolution

Property Name Description Default Value

VITE_TENANT_RESOLVER_ADMIN_URL

The URL suffix to be used in the resolution of admin tenant information.

/api/tenant/resolver/admin

VITE_TENANT_APPLICATIONS_URL

The URL suffix to be used when retrieving the set of applications for the given tenant.

/api/tenant/applications

VITE_TENANT_URLRESOLVER_APPLICATION_URL

The URL suffix to be used in the resolution of the URL of a given application, particularly used in impersonating users and in previewing changes via the Admin Client.

/api/tenant/url-resolver/application

Content Policy

Tip
Read more about Content Security Policies here.
Property Name Description Default Value

VITE_ENABLE_STRING_EVAL

Determines what template function will be used when compiling a string from a template and context object. Typically used to evaluate strings like URL strings with parameters and passing in an object whose attributes match the parameters.

If the value is false, a "safe" template function will be used which replaces Lodash’s _template function, since that isn’t compatible with Content Security Policy headers. Otherwise, if the value is true, then Lodash’s _template function is used.

false

Property Name Description Default Value

VITE_ENABLE_NAVIGATION_FILTER

Toggles the display of the Navigation section filter field.

true

Developer Settings

Property Name Description Default Value

VITE_ENABLE_DEV_SETTINGS

Toggles the enabling of developer settings.

true

VITE_DEFAULT_TIME_ZONE

Determines the timezone to be used by Admin Client.

By default, this property is commented out, which makes the Admin Client use the system’s timezone. The list of valid timezone names can be found in the moment-timezone library Github repository or the more readable list of the tz database timezones in Wikipedia.

America/New_York

VITE_ENABLE_PKCE

Toggles the enabling of the usage of PKCE in OAuth-related flows.

true

VITE_LOG_LEVEL

The fixed log level of log statements.

info

VITE_ENABLE_LOG_DECORATION

Toggles the decoration of log statements with a prefix pattern including the timestamp, level, and moduleName.

true