Instance Settings
Override Configuration Admin settings on deploy.
# description
Sets values on any Liferay `@Meta.OCD` configuration by its PID (persistent identity). Effectively configuration-as-code for anything Configuration Admin exposes. Extra keys beyond the base fields are driven by the target PID's schema — the validator does not enforce them.
Register OAuth apps and override Configuration Admin settings.
# when to use
- →You want a specific Liferay setting locked in on deploy (e.g., accessibility menu enabled).
- →You're replacing manual Instance Settings config with something checked into source.
# how to use
- 01Find the PID for the config you want to set (e.g.,
com.liferay.frontend.js.web.internal.configuration.FrontendJSWebConfiguration). - 02Set
pid:to it and add the config keys as sibling YAML keys. - 03Deploy — the values are applied when the extension is registered.
# required fields
| field | type | description |
|---|---|---|
pidrequired | string | Java class name of the target configuration's @Meta.OCD PID. |
# optional fields
| field | type | description |
|---|---|---|
name | string | Display name. |
description | string | Description. |
siteExternalReferenceCode | string | Scope the setting to a specific site. |
# example
client-extension.yaml
accessibility-menu:
type: instanceSettings
pid: com.liferay.frontend.js.top.head.extender.internal.configuration.FrontendJSTopHeadExtenderConfiguration
enableAccessibilityMenu: true