Site Initializer YAML Configuration Reference

Liferay Self-Hosted Liferay SaaS Liferay PaaS

Liferay 7.4

Use a client-extension.yaml file to define a Site Initializer client extension.

Usage Details

This client-extension.yaml file defines a client extension of type siteInitializer:

liferay-sample-site-initializer:
    name: Liferay Sample Site Initializer
    oAuthApplicationHeadlessServer: liferay-sample-site-initializer-oauth-application-headless-server
    siteExternalReferenceCode: liferaySample
    siteName: Liferay Sample
    type: siteInitializer

liferay-sample-site-initializer-oauth-application-headless-server:
    .serviceAddress: localhost:8080
    .serviceScheme: http
    name: Liferay Sample OAuth Application Headless Server
    scopes:
        - Liferay.Headless.Site.everything
    type: oAuthApplicationHeadlessServer

The required siteName property defines the new site’s name when it’s deployed. The client extension also requires an OAuth headless server client extension to authenticate.

The sample workspace includes a complete Site Initializer client extension.

YAML Properties

These properties are specific to Site Initializer client extensions:

Name	Data Type	Description
`siteExternalReferenceCode`	String	An external reference code used to identify the site uniquely.
`siteName`	String	The site’s name when it’s deployed to a Liferay instance.