Backdrop Plugin

The Probo.CI Backdrop plugin provides an easy way to set Backdrop CMS site configuration options in your application build and quickly integrate a Backdrop website’s repository. To use the Probo.CI Backdrop plugin you must declare plugin: Backdrop in a step in your .probo.yaml file. The Backdrop plugin’s parameters can automate steps specific to Backdrop such as writing settings.php, importing a database, running database updates, performing a fresh site install, or clearing caches.

The Probo.CI Backdrop plugin inherits all Probo PHP/LAMP configuration options. This allows additional Probo.CI build steps in your .probo.yaml file to layer LAMP configuration options and commands on top of the Backdrop site specific configuration.

Backdrop’s bee command line utility is installed automatically as part of the plugin, so options such as databaseUpdates, clearCaches and runInstall work out of the box — you do not need to add a step to install it yourself.

See the Probo.CI Backdrop Examples and Demonstrations section below for a full YAML config example. We can also help you get started building your .probo.yaml file.

Directory Configuration

• subDirectory {string}

  The path to your docroot if it is a subdirectory of your git repository. Defaults to docroot.

  Example

  steps: - name: Set Subdirectory plugin: Backdrop subDirectory: docroot

• activeConfigSyncDirectory {string}

  The location of the active configuration directory, written to $config_directories['active'] in settings.php. Defaults to ../config/active.

  Example

  steps: - name: Set active config directory plugin: Backdrop activeConfigSyncDirectory: ../config/active

• stagingConfigSyncDirectory {string}

  The location of the staging configuration directory, written to $config_directories['staging'] in settings.php. Defaults to ../config/staging.

  Example

  steps: - name: Set staging config directory plugin: Backdrop stagingConfigSyncDirectory: ../config/staging

Database Configuration

• database {string}

  The file name of the database to import if specified. Note that this database must be added to the assets array separately.

  Example

  assets: - backdrop.sql.gz steps: - name: Import database plugin: Backdrop database: backdrop.sql.gz

• databaseName {string}

  The name of the database. Defaults to backdrop.

  Example

  steps: - name: Set database name plugin: Backdrop databaseName: backdrop

• databaseGzipped {boolean}

  Whether the database was sent gzipped and whether it should therefore be gunzipped before importing.

  Example

  steps: - name: Unzip database plugin: Backdrop databaseGzipped: true

• databaseBzipped {boolean}

  Whether the database was sent bzipped and whether it should therefore be bunzipped before importing.

  Example

  steps: - name: Unzip database plugin: Backdrop databaseBzipped: true

• databasePrefix {string}

  A prefix for the database tables, written to $database_prefix in settings.php. Defaults to an empty string.

  Example

  steps: - name: Set database prefix plugin: Backdrop databasePrefix: backdrop_

Settings.php Options

• settingsRequireFile {string}

  A file to require at the end of settings.php. This option helps you to avoid checking settings.php into your repository.

  Example

  # Require checked in settings steps: - name: Require Probo-specific site settings plugin: Backdrop settingsRequireFile: settings.probo.php # Use an uploaded asset assets: - probo-settings.php steps: - name: Require Probo-specific site settings plugin: Backdrop settingsRequireFile: $ASSET_DIR/probo-settings.php

• settingsAppend {string}

  Specify a snippet, such as a variable, to append to the end of the settings.php file.

  Example

  steps: - name: Append to settings.php plugin: Backdrop settingsAppend: | $bar = 'baz'; $foo = 'stuff';

Additional Options

• databaseUpdates {boolean}

  Determines whether to run bee updb after the build is finished. Defaults to false.

  Example

  steps: - name: Run database updates plugin: Backdrop databaseUpdates: true

• clearCaches {boolean}

  Whether to clear all caches using bee cache-clear all after the build is finished. Defaults to false.

  Example

  steps: - name: Clear caches plugin: Backdrop clearCaches: true

• runInstall {boolean}

  If set to true, run bee site-install to perform a fresh install of the site using profileName as the installation profile and installArgs to further configure the install. Defaults to false.

  Example

  steps: - name: Install a fresh site plugin: Backdrop runInstall: true profileName: standard

• profileName {string}

  The installation profile to use when runInstall is set. Defaults to standard.

  Example

  steps: - name: Install with a custom profile plugin: Backdrop runInstall: true profileName: minimal

• installArgs {string}

  A set of parameters to concatenate onto the bee site-install command when runInstall is set. Defaults to an empty string.

  Example

  steps: - name: Install with additional arguments plugin: Backdrop runInstall: true profileName: standard installArgs: --account-name=admin --account-pass=admin

Backdrop Example

Using the Backdrop plugin

This example takes a database from a Backdrop CMS site and integrates it into your Probo build. The web root lives in a docroot subdirectory, and the active and staging configuration directories are set so Backdrop can read its site configuration. Backdrop’s bee command line utility is installed automatically by the plugin, so no separate step is needed to make it available.

type: lamp
php: 8.4
database: mariadb:11.4
assets:
  - backdrop.sql.gz

steps:
  - name: Setup Backdrop CMS
    plugin: Backdrop
    subDirectory: docroot
    database: backdrop.sql.gz
    databaseGzipped: true
    activeConfigSyncDirectory: ../config/active
    stagingConfigSyncDirectory: ../config/staging

For more ways to configure Probo.CI for your Backdrop application, checkout our Probo Examples & Demonstration page. There you can see practical real-world examples.

Related Articles & Information

---

Demonstration Repositories