Crafter CMS Intermediate Publishing Environment

Crafter CMS supports an intermediate environment to publish to, named staging, where the site can be fully exercised with regards to system and integration points. This staging environment allows testing of your site. Once validated in the staging environment, items can be pushed live. This staging environment precedes the live environment.

When the staging environment is setup, the Request Publish and Approve for Publish dialogs gives the user the option to select to which environment to publish to:

System Administrator - Staging Environment Setup for Publish dialogs

Users with access to the following widgets in the dashboard will see a column named Environment indicating which environment an item has been/would be published to: Items Waiting For Approval, Approved Scheduled Items and Recently Published

System Administrator - Dashboard

Notice the pages published to staging and live with the same time in the above image. When the intermediate environment is setup, all items will go through the staging environment before going to live. So, if a user approves an item to be published directly to live, it will be published to staging first, then onto live.

Setting Up the Intermediate Environment per Site

The intermediate environment is setup per site and by default is not enabled. To enable the intermediate environment for your site, click on siteConfig from the bottom of the Sidebar, then click on Configuration and select Site Configuration from the dropdown list.

Under the <published-repository> tags, set <enable-staging-environment> to true. You can also change the default names for your staging environment and your live environment repos here.

1
2
3
4
5
<published-repository>
   <enable-staging-environment>true</enable-staging-environment>
   <staging-environment>staging</staging-environment>
   <live-environment>live</live-environment>
</published-repository>

To view your site with respect to the staging environment, we need to set it up for delivery. To setup your site for the staging environment, run the init-site script and follow the instructions in Setup Site for a Delivery Environment using the staging branch in the options.

./init-site.sh -b staging mysite-staging /path/to/published/repo

Setting Default Repo Branch Names

Crafter CMS allows you to set default branch names for the live and staging environments when not using the environment-config.xml. In your Authoring installation, go to shared/classes/crafter/studio/extension and open the file studio-config-override.yaml. The current default names are live and staging. To change the default names, uncomment and change the defaults set:

shared/classes/crafter/studio/extension/studio-config-override.yaml
1
2
3
4
5
# If not using environment-config.xml, environments are configured here
# Git repository branch for the `live` environment, default "live"
# studio.repo.published.live: live
# Git repository branch for the `staging` environment, default "staging"
# studio.repo.published.staging: staging