Operations Experience Project
  • Operations Experience Project
  • OX: Operator Experience
    • Good OX
  • Site Runner
    • GitOps Hosting
  • Tools
    • Site Module & Site Manager
    • ash: Drush Alias Shell
    • Drush Behat Params
Powered by GitBook
On this page
Edit on GitHub
  1. Tools

Site Module & Site Manager

All about Site Manager and how to use it.

PreviousToolsNextash: Drush Alias Shell

Last updated 1 year ago

CtrlK
  • Site Module
  • Site Manager

Site Module

Site.module is a Drupal module that provides a way to track the state of your website over time.

Site state indicator.

In addition to URLs, Site entities store properties about the site such as Last Cron, Install Time, PHP and Drupal Versions.

It uses Drupal status report & Site Audit module to determine an overall state of your Drupal site. Create your own simple plugins for storing properties and affect state.

Site entity properties are Drupal fields. This means that you can use any Drupal site building API to create your own Site Manager Dashboard.

Site entity teaser. Field and Layout API compatible.

Site entities have revisions for tracking site information over time. Event handlers can trigger a site revision, including a log message. This provides a history of changes over time, including what configuration changes occured.

Site Manager

Site Manager is used for storing information on many sites in one place. It has an API that allows it to receive site entities from remote sites.

Projects dashboard. Site Manager has entities for Projects and environments

Since site.module lets a Drupal site post out from itself, any site hosted anywhere can send updates to a Site Manager. This includes CI environments, even ephemeral ones running in git runners or ones protected from behind a firewall.

Site API

Site Manager uses Drupal's JSON:API to send and receive site entities from remote locations.

Drupal sites with Site.module installed can post information to a Site Manager or any other URL.

Non-Drupal systems can also post site information to a Site Manager via JSON:API. See the Drupal.org JSON:API documentation for general information.

Manage sites like content. Add site.module to give a site the ability to post itself back to a Site Manager.