Before installing this package your site must be hosted on an environment that allows you to install and run other software through PHP such as a VPS. The application makes use of the following utilities:
To install the above on Ubuntu:
sudo apt-get install jpegoptim sudo apt-get install optipng sudo apt-get install pngquant sudo npm install -g svgo sudo apt-get install gifsicle
brew install jpegoptim brew install optipng brew install pngquant brew install svgo brew install gifsicle
- PHP >= 7
- Perch / Runway >= 3.0
Adding to Perch
redfinch_optim directory to
perch/addons/apps. Once complete you should see the app appear in the sidebar menu.
If not already, you should enable Scheduled Tasks for the optimisation tasks to be automatically run.
Once installed there are a wide variety of settings that can be modified depending on your requirements:
- Enable or disable optimisation tools
- Set the compression amount
- Strip file meta data for smaller sizes
- Enable or disable SVG optimisation plugins
The optimiser task will run once every 24 hours and will use a high level of CPU power to compress images. If you find that this is too much you can:
- Reduce the compression level. PNG optimisation can be particularly resource intensive
- Increase the image quality
- Disable the particular optimiser.
You can additionally set a max execution time in the Perch settings panel. By default this is set to 30 seconds.
This addon will only work for images that are stored locally. Files using cloud storage providers such as Amazon S3 cannot be optimised using this tool.
If you are not on a platform that can install and run the tools listed in the prerequisites section then the official Perch Kraken application may be suitable.
Copyright (c) 2017 James Wigger / Red Finch
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.