Flamenco / grav-plugin-core-service-manager

MIT License
2 stars 2 forks source link

Core Service Manager Plugin

The Core Service Manager Plugin is for Grav CMS. It adds a service manager layer to the Grav API. This plugin provides no end-user features on its own. It extends the Grav core with services and features to be used by other plugins.

Installation

Installing the Core Service Manager plugin can be done in one of two ways. The GPM (Grav Package Manager) installation method enables you to quickly and easily install the plugin with a simple terminal command, while the manual method enables you to do so via a zip file.

GPM Installation (Preferred)

The simplest way to install this plugin is via the Grav Package Manager (GPM) through your system's terminal (also called the command line). From the root of your Grav install type:

bin/gpm install core-service-manager

This will install the Core Service Manager plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/core-service-manager.

Manual Installation

To install this plugin, just download the zip version of this repository and unzip it under /your/site/grav/user/plugins. Then, rename the folder to core-service-manager. You can find these files on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/core-service-manager

NOTE: This plugin is a modular component for Grav which requires Grav and the Error and Problems to operate.

Configuration

Before configuring this plugin, you should copy the user/plugins/core-service-manager/core-service-manager.yaml to user/config/plugins/core-service-manager.yaml and only edit that copy.

Here is the default configuration and an explanation of available options:

enabled: true
override_admin_twigs: true

Usage

This plugin provides services intended to be used by other plugins. Disable it only if no other enabled plugins require it. See the official documentation for usage details.

To Do

[ ] Service reference counts [ ] Require scope to be a property