ANKIMAGE
LAB

DOCUMENTATION

ANK Image Compress for Joomla

Install the extension, connect an API key, and optimize existing or newly added images.

Requirements

Joomla 5/6, PHP 8.3 or newer with cURL, OpenSSL and fileinfo, a writable images folder, and a writable private folder next to the site root. The API accepts non-animated JPEG, PNG and WebP files up to 5 MB and 20 megapixels.

1. Install the package

Download version 0.1.2. In Joomla, open System → Install → Extensions and upload the ZIP. The package installs the administrator component and scheduled-task plugin together.

2. Connect your account

Create an account at ANK Image Lab and create an API key. In Joomla, open Components → ANK Image Compress, enter the key and save. The dashboard shows available credits and cumulative space savings. The key is stored encrypted; leave the field empty when saving later settings to retain it.

3. Compress existing images

The component scans JPEG, PNG and WebP files in images and its subfolders. Use Compress for one file or Compress all pending for a batch. Search by file name and move between pages of 50 results. Images that are already compressed can be restored with Restore original. The private backup of each original is kept outside the public site root.

4. Optimize new images automatically

In System → Plugins, enable ANK Image Compress - automatic optimization. In the component settings, enable automatic processing and save. Then open System → Scheduled Tasks, create an Optimize new images task and choose a suitable interval, such as five minutes. Make sure Joomla's task scheduler is running; a typical server cron command is php /path/to/site/cli/joomla.php scheduler:run --all.

Service and limits

Image bytes are sent over HTTPS to the ANK Image Lab API. The extension does not send Joomla credentials or image paths. The account includes 500 successful compressions each calendar month at no charge; additional credits are optional. See current API pricing, privacy details and the extension GPL license.

Need help?

Send the file format, approximate size, the error shown in Joomla, and steps to reproduce the issue. Do not send API keys.

modules@ankpicpress.com