Skip to main content

cms — module reference

Rendered from the module's own manifest, and from nothing written by hand. What the module does is its own page.

Module idcms
NameCMS
Version1.0.0
Ships from@endora-commerce/mod-cms
LicenceMIT

Activation​

An operator switches this module on and off on /platform/modules. The choice is the setting cms.enabled, and it defaults to on.

Dependencies​

ModuleBindingWhat it means
_i18nyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
assets_libraryyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
authyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
emailyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
languagesyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
sales_channelsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
settingsyesinstalls and migrates after it, and an operator cannot switch it off underneath this module
credentialsnodegrades-without credentialsService — Page Builder translation reports itself unavailable; every other CMS function keeps working.

Permissions​

CodeLabelAlso needs
cms.brandEdit brand settingscms.read
cms.readView CMS content—
cms.translateTranslate Page Builder content with AI—
cms.writeEdit CMS content—

Command palette​

ActionOpensPermission
new-page/cms/pages/newcms.write
open-blocks/cms/blockscms.read
open-cms-brand/cms/brandcms.read
open-contact-form-settings/settingssettings:read
open-hooks/cms/hookscms.read
open-page-builder-translation-settings/settingssettings:read
open-pages/cms/pagescms.read
open-templates/cms/templatescms.read

Settings​

CodeNameType
cms.contact_form_recipientsContact form recipientsstring_list
cms.default_share_image_asset_idDefault sharing imagestring
cms.enabledCMS enabledboolean
cms.page_builder.breakpoint.desktop_minDesktop breakpoint (min-width px)number
cms.page_builder.breakpoint.tablet_minTablet breakpoint (min-width px)number
cms.page_builder.color_palettePage Builder color palettejson
cms.page_builder.translation.enabledTranslation enabledboolean
cms.page_builder.translation.llm_credentialsTranslation credentialscredential_ref
cms.page_builder.translation.max_source_charactersTranslation size limit (characters)number
cms.reserved_slug_segmentsReserved page-slug segmentsjson

Translations​

Bundles at i18n inside the module, one file per shipped language.

Operator commands​

Run these in the root of an instance. In a checkout of the Endora Commerce repository the same commands are pnpm --filter backend run cli -- cms <command>.

CommandWhat it does
pnpm run cli cms block-namesReport the Page Builder block names stored in this database, and what the namespacing migration will do to each. Read-only.