rokka is digital image processing done right. Store, render and deliver images. Easy and blazingly fast. This plugin automatically uploads your pictures to rokka and delivers them in the right format, as light and as fast as possible. And you only pay what you use, no upfront and fixed costs.
Free account plans are available. Just install the plugin, register and use it.
This is still beta software. We use this for our Liip company webpage, so it's somehow battle tested. But there's still room for improvements and some behind the scene code will change, the kirby API will stay stable, hopefully. And input is always welcome.
- PHP 7.1
- Kirby 3.0+
- Rokka API key (free plan available).
- Rokka PHP Client 1.1+. Installed via composer, see below.
The recommended way
composer require rokka/kirby:"dev-master as 0.1.0-dev"
git submodule add https://github.com/rokka-io/rokka-kirby-plugin.git site/plugins/rokka composer require rokka/client
Copy and Paste
- Download the contents of this repository as ZIP-file.
- Rename the extracted folder to
rokkaand copy it into the
site/plugins/directory in your Kirby project.
composer require rokka/client
site/config.php activate the plugin and set the ROKKA API key .
c::set('rokka.kirby.enabled', true); c::set('rokka.kirby.organization', 'YOUR_ORG_NAME_HERE'); c::set('rokka.kirby.apikey', 'YOUR_API_KEY_HERE');
The following is also recommended for shorter, nicer image URLS (see below in "Defining Stacks"):
c::set('rokka.kirby.stacks', [ 'noop' => 'kirby_noop', 'resize' => 'kirby_resize', 'crop' => 'kirby_crop' 'raw' => 'kirby_raw', 'kirbytext' => 'kirby_text', // default stack for kirbytext image includes 'resize-800x10000' => 'kirby_text' //images in kirbytext will have a width of 800px ]);
After having added that, you have to call
https://yourkirbysite.com/_rokka/create-stacks (and be logged in) to
create the actual stacks on the rokka server.
The plugin adds a
$myFile->rokkaCropUrl($width, $height, $format = "jpg"),
$myFile->rokkaResizeUrl($width, $height, $format = "jpg") and a
$myFile->rokkaOriginalSizeUrl($format="jpg") function to $file objects.
You can use them like the following in your templates:
// get any image/file object $myFile = $page->file('image.jpg'); // get url (on your webserver) for optimized thumb $url = $myFile->rokkaCropUrl(500,500);
$myFile->rokka($stackname, $extension) for returning an html img tag with using a stack and
$myFile->rokkaGetHash() for getting the rokka hash of an image.
Rokka has a concept of stacks, which allow to have nicer URLs.
You can configure some stacks with the
rokka.kirby.stacks configure option. If you for example use certain sizes a lot, you should use a stack. For example, if you do
$myFile->rokkaResizeUrl(300,300), then define a stack with
c::set('rokka.kirby.stacks', [ `crop-200x200' => 'kirby_thumbnail', `resize-300x300' => 'kirby_resized', 'noop' => 'kirby_noop', 'resize' => 'kirby_resize', 'crop' => 'kirby_crop', 'raw' => 'kirby_raw', ]);
The value of the array (in this example www_thumbnail) is the used stack name. It can be an ascii text, you can use there whatever you want.
raw keys have a special meaning and you should define them like in the example above,
but you can change the name of the actual stacks
After you defined your stacks, open the URL
https://yourkirbysite.com/_rokka/create-stacks, after you logged in into the Panel.
This will create your stacks on the Rokka server. A panel option for this will come one day. You only have to do this
once, but whenever you change some of the stack definitions.
You can also set stack options for those stacks with eg.
c::set('rokka.kirby.stacks.options', [ 'resize-300x300' => ['options' => ['webp.quality' => 80]], 'crop-200x200' => ['options' => ['jpg.quality' => 85]], 'resize-800x10000' => [ 'operations' => ['resize' => ['options' => ['upscale' => false]]], // don't upscale picture, if they're smaller than the width 'options' => ['webp.quality' => 80] ], ]);
And if you want different settings for retina screens you can add an 'options-retina' key
c::set('rokka.kirby.stacks.options', [ 'resize-300x300' => [ 'options' => ['webp.quality' => 80], 'options-retina' => ['webp.quality' => 60] ], ]);
All available Stack options can be found on the rokka documentation.
To be more documented.
Get html attribute snippets with
srcset enabled tags with retina resolutions.
This plugin overwrites the kirbytext
image tag and serves pictures from rokka if that is used.
This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.