README

This module adds version control integration for the CMS structure of a Ride application.

It's used when you have to maintain multiple installations of your CMS site, for example a test instance or a developer instance.

This module will block structural changes on your CMS nodes when you don't have the latest version. A message is displayed to update your repository with a link to the page where you can perform the update action.

Note: this module has a negative performance impact on your backend.

Parameters

• cms.repository.branch: Name of the branch inside the repository eg. content-dev
• cms.repository.private.key: Path to the private key used to access the repository (optional)
• cms.repository.url: URL to the repository eg. git@github.com:all-ride/ride-web-cms-vcs.git

Usage

You can browse to /sites/repository to check the status of your repository. This page allows you to pull the latest changes into your local installation.

When you try to save a CMS node while the local copy of the repository is outdated, your action is blocked and a message is displayed to perform an update action first. This way, you never have to solve merge conflicts.

Related Modules

• ride/app
• ride/app-vcs
• ride/lib-vcs
• ride/web
• ride/web-base
• ride/web-cms

Installation

You can use Composer to install this module.

composer require ride/web-cms-vcs