System Settings

The system settings for Backstage should be configured for you during the installation process. However, you may need to update these settings if you change your site's configuration or if you need to troubleshoot an issue.

Approval Settings

The Approval settings relate to permissions and approval workflows in Backstage. You can configure the following settings:

Setting	Description	Default Value
backstage.approve_chunks	Enable or disable chunk approval.	`No`
backstage.approve_plugins	Enable or disable plugin approval.	`No`
backstage.approve_propertysets	Enable or disable property set approval.	`No`
backstage.approve_resources	Enable or disable resource approval.	`No`
backstage.approve_snippets	Enable or disable snippet approval.	`No`
backstage.approve_templates	Enable or disable template approval.	`No`
backstage.approve_tvs	Enable or disable TV approval.	`No`
backstage.self_deploy	Allow users to deploy their own changes.	`Yes`
backstage.show_deploy_all	Show the "Deploy All" button.	`Yes`

Changeset Settings

The Changeset settings relate to changesets in Backstage. You can configure the following settings:

Setting	Description	Default Value
backstage.autocomplete_changeset	Automatically complete a changeset when all items are deployed.	`Yes`
backstage.changesets_default_filter	The default filter for changesets. Recommend setting to `_any` for All changesets or `_none` for No changesets	`_any`
backstage.deploy_changesets	Enable or disable changeset deployment.	`Yes`

Deployment Settings

The Deployment settings relate to deployment in Backstage. You can configure the following settings:

Setting	Description	Default Value
backstage.additional_tpls	Extra TPLs that will show in the changes grid. Format: `[{"unique_key":{"name":"TPL Name", "tpl":"/absolute/path/to/tpl","acl":"acl_to_check_for_access"}}]`	`[]`
backstage.api	The URL to the Backstage API. (Do not touch!)	`https://backstage.api.modx.cloud`
backstage.bulk_tpl	Path to the tpl that will be used for bulk deployment.	`/www/core/components/backstage/tpl/v2/backstage_bulk.tpl.json`
backstage.targets	The deployment taget(s) for your live environment
backstage.tpl	Path to the tpl that will be used for deployment.	`/www/core/components/backstage/tpl/v2/backstage.tpl.json`

Tracking Settings

The Tracking settings relate to tracking in Backstage. You can configure the following settings:

Setting	Description	Default Value
backstage.assets_tv_list	Comma-separated list of template variables IDs to scan for assets.
backstage.track_created_files	Track files created by the user.	`Yes`
backstage.track_deleted_files	Track files deleted by the user.	`Yes`
backstage.track_renamed_files	Track files renamed by the user.	`Yes`
backstage.skip_scan_resources	Comma separated list of resource IDs to skip asset scanning on when saving. This field is mostly automated but can be manually edited if a Resource is failing to save

Experimental Settings

The Experimental settings relate to experimental features in Backstage. You can configure the following settings:

Setting	Description	Default Value
backstage.automated_resource_graph	Automatically create a resource graph based on installed plugins.	`No`
backstage.automated_resource_graph_depth	The depth of the automated resource graph.	`1`
backstage.automated_resource_graph_exclude	A comma-separated list of classes names to exclude from the automated resource graph.	`modUser`

Last modified: 23 January 2025