https://github.com/getgrav/grav-plugin-optimus
Grav Optimus Plugin
https://github.com/getgrav/grav-plugin-optimus
compression grav grav-plugin optimization optimus
Last synced: about 1 year ago
JSON representation
Grav Optimus Plugin
- Host: GitHub
- URL: https://github.com/getgrav/grav-plugin-optimus
- Owner: getgrav
- License: mit
- Created: 2015-07-17T19:51:01.000Z (almost 11 years ago)
- Default Branch: develop
- Last Pushed: 2018-03-11T06:23:51.000Z (about 8 years ago)
- Last Synced: 2025-04-19T07:42:38.515Z (about 1 year ago)
- Topics: compression, grav, grav-plugin, optimization, optimus
- Language: PHP
- Homepage: https://getgrav.org
- Size: 9.77 KB
- Stars: 5
- Watchers: 5
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Grav Optimus Plugin
`Optimus` is a powerful [Grav](http://getgrav.org) Plugin that automatically processes your Page Media Images through the [Optimus](https://optimus.io/en/) 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)](http://learn.getgrav.org/advanced/grav-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](https://github.com/getgrav/grav-plugin-optimus) or via [GetGrav.org](http://getgrav.org/downloads/plugins#extras).
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](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.