Grav Optimus Plugin
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
classes
CHANGLEOG.md
LICENSE
README.md
blueprints.yaml
optimus.php
optimus.yaml

README.md

Grav Optimus Plugin

Optimus is a powerful Grav Plugin that automatically processes your Page Media Images through the Optimus lossless compression service.

Installation

Installing the Optimus plugin can be done in one of two ways. Our 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 optimus

This will install the Optimus plugin into your /user/plugins directory within Grav. Its files can be found under /your/site/grav/user/plugins/optimus.

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 optimus. You can find these files either on GitHub or via GetGrav.org.

You should now have all the plugin files under

/your/site/grav/user/plugins/optimus

Config Defaults

enabled: true
license_key: YOUR_OPTIMUS_KEY

You will need to replace YOUR_OPTIMUS_KEY with the key you were assigned when you signed up for the Optimus service. The best process to do this is to copy the optimus.yaml file into your user/config/plugins/ folder (create it if it doesn't exist), and then modify there. This will override the default settings.

Usage

When enabled the plugin will automatically send every Page Media Image file to the Optimus server for compression processing. This can cause a bit of a delay on the intial page load as each image has to make a round trip to the server. This only happens the first time however, as each image is then cached for future use.