File Optimizer plugin Documentation

Compress the images, PDFs, videos and audios stored on your site — locally or through cloud APIs — generate WebP copies, and let the web server transparently deliver the optimized versions instead of the originals. Your original files are never modified.

How It Works

1. Scan — the add-on indexes every optimizable file of your public storage into its own catalog (path, type, size).
2. Optimize — each file is compressed by the engine you selected. When the result is smaller than the original (by at least the configured threshold), the optimized copy is saved into the mirror folder storage/app/public/_optimized/<same path>. For images, an optional .webp sibling is generated as well.
3. Serve — rewrite rules added to your web server check, for every /storage/... request, whether an optimized copy (or a WebP variant, when the browser accepts it) exists. If yes, it is served; if not, the original file is served exactly as before.

Use Cases

Speed Up an Existing Site

Years of uploads pile up. Scan the storage once, click “Optimize everything”, and let the add-on compress your whole media library in the background — then serve WebP to the ~97% of browsers that support it.

Improve Core Web Vitals & SEO

Smaller images mean faster LCP and better PageSpeed scores. The Vary: Accept header is set correctly so caches and CDNs keep working.

Reduce Bandwidth & Storage Costs

Image savings of 30–70% are common. The overview page tracks the exact number of bytes saved per file type.

Compress Heavy Documents

Scanned PDFs and brochures shrink dramatically with the Ghostscript ebook preset while staying perfectly readable on screen.

Requirements

• One of the supported platforms:
  • Larapen CMS v1.0.0 or later
  • LaraClassifier v19.0.0 or later
  • JobClass v19.0.0 or later
• PHP 8.3+, MySQL 8.0+
• The public storage symlink (php artisan storage:link) — standard on every install
• Optional local binaries depending on the engines you enable:
  • Images: jpegoptim, optipng, pngquant, svgo, gifsicle
  • WebP: cwebp (or the Imagick / GD PHP extensions)
  • PDFs: gs (Ghostscript)
  • Videos & audios: ffmpeg

Installation

Step 1: Upload the Add-on

In the admin panel, go to Admin → Extensions → Add-ons and click the Upload Add-on button. Select the add-on’s ZIP file: the system extracts it automatically and the add-on appears in the installed add-ons list.

Step 2: Activate the Add-on

Find File Optimizer in the list and click Activate. Activation:

• runs the database migrations (two tables prefixed with fileoptimizer_),
• registers the admin permissions,
• installs the rewrite rules into public/.htaccess (Apache/LiteSpeed servers).

Step 3: Configure & Scan

Open Admin → File Optimizer → Settings to pick your engines, then go to the Overview page and click Scan storage.

Purchase Code (License Key)

File Optimizer is sold as a separate product, so it has its own purchase code (license key) — distinct from the purchase code of the main application and from the one of every other add-on. You are asked for it when you activate File Optimizer in Admin panel → Add-ons.

Our products are sold on three platforms. The way you receive a purchase code depends on where you bought the product.

1. bedigit.com Store (in-site purchase)

• As soon as the order’s payment status becomes Paid, a license key is generated automatically for every licensed item in the order (one key per purchased unit — buying 3 units gives 3 distinct keys).
• It is emailed to the address used on the order, either in a dedicated license email or inside the order confirmation email. Check your inbox and your spam / junk folder.
• The key stays available in your account under My Account → My Licenses. Keys are masked in the list; open the license detail page to reveal and copy the full key, see the domains it is activated on, and deactivate a domain to free an activation slot.
• The matching invoice is under My Account → My Orders.

2. Gumroad

• A Gumroad purchase produces two separate emails: the Gumroad receipt (sent by Gumroad, giving access to the files) and a license key email (sent by bedigit.com) that contains your purchase code.
• The license key email is generated as soon as Gumroad notifies us of the sale, so it normally arrives within seconds of the payment. Here too, check your inbox and your spam / junk folder.
• When the Gumroad product uses Gumroad’s own license-key feature, the same key also appears in your Gumroad receipt and under Library → your purchase on gumroad.com.
• Use the same email address on bedigit.com as on Gumroad: your keys are then linked to your account automatically and listed under My Account → My Licenses, even if you register after the purchase. You can also add a Gumroad key manually from My Account → My Gumroad Licenses.

3. Envato Market (CodeCanyon)

• Envato purchase codes are issued and delivered by Envato Market, never emailed by us — so there is nothing to look for in your spam folder: you retrieve the code from your Envato account.
• Log in to your Envato / CodeCanyon account, open the Downloads page, find the item, and choose License certificate & purchase code from the Download dropdown. The code is written in that certificate.
• An Envato purchase code looks like 12345678-90ab-cdef-1234-567890abcdef (8-4-4-4-12 characters). It never changes, and renewing item support does not issue a new one.
• Official Envato article: Where Is My Purchase Code?

Quick Start (2 minutes)

1. Activate the add-on.
2. Go to File Optimizer → Overview and click Scan storage.
3. Click Optimize everything and keep the page open until the progress bar completes (or let your queue worker do the job).
4. Open Settings → Rewrite rules and click Test the rules (live probe) to confirm the optimized copies are being served.

Admin: Overview Page

Admin → File Optimizer shows at a glance:

• the total number of indexed files and the total space saved,
• one card per file type (Images, PDFs, Videos, Audios) with its counters — total, optimized, pending, failed — its disk usage and savings, plus quick Browse and Optimize buttons,
• the recent optimization runs and their results,
• the live progress bar of a run currently in progress (it survives page reloads).

A paused badge on a card means optimization is disabled for that type in the settings.

Scanning the Storage

The scanner walks the public storage and indexes every file whose extension matches an enabled type. It runs in short chunks (a few seconds each), so it can index tens of thousands of files without timeouts or memory spikes.

• New files are added as Pending.
• Modified files (size or date changed since the last scan) are reset to Pending and their stale optimized copies are deleted immediately, so outdated content is never served.
• Deleted files are removed from the catalog along with their optimized copies.

Re-run the scan whenever you add or replace files. You can also automate it — see Console Commands.

Browsing Files

The sidebar offers one page per type: Images, PDFs, Videos and Audios. Each page lists the indexed files with a thumbnail (images), the path, original size, optimized size, savings percentage, WebP badge and status.

Filters & Search

The header of the list offers:

• a search box matching the file path (updates the table as you type),
• a status filter (Pending, Queued, Processing, Optimized, Skipped, Failed),
• an extension filter listing the extensions actually present,
• a Clear button resetting all filters.

Filtering refreshes only the table, without reloading the page.

File Actions

Optimizing Files

Single File

Click the lightning button on any row. The row updates in place with the new size, savings and status.

Bulk & Optimize All

• Selection — tick the checkboxes (or the header checkbox) and click Optimize selected (n).
• Whole type — click Optimize all <type> in the page header.
• Everything — click Optimize everything on the Overview page.

Only files in Pending or Failed status are queued; types disabled in the settings are ignored.

Progress Bar

Every bulk run shows a progress bar with the processed / optimized / skipped / failed counters and the bytes saved so far, plus a Cancel button. Two processing modes exist (see General settings):

• Browser-driven (default when no queue worker is configured) — the page sends a short request every few seconds; each one processes a handful of files. Keep the page open until the bar completes.
• Queue — one job per file is dispatched to your queue worker; the page only polls the progress. You can safely leave the page.

Cancelling a run releases the remaining files back to Pending.

Deleting Optimized Copies

To go back to the original files: use the row trash button for one file, or select several rows and click Delete optimized (n). The optimized and WebP copies are deleted from the mirror folder and the originals are served again immediately.

Settings: General

Settings: Images & WebP

Settings: PDFs

Settings: Videos

Video compression runs locally through FFmpeg and is disabled by default: transcoding is CPU-intensive and should be an explicit choice.

The optimized copy keeps the original container/extension (WebM stays WebM with VP9/Opus, MP4 stays MP4 with H.264/AAC), so the rewrite rules can serve it under the original URL.

Settings: Audios

Audio compression also runs locally through FFmpeg and is disabled by default.

Settings: Server Binaries

Under Settings → General → Server binaries, you can:

• set an absolute path for each binary when it lives outside the system PATH (common with PHP-FPM),
• click Check binaries to see which tools are installed and their version — a green Available or red Not found badge appears next to each field,
• follow the Website & download link under each field to install a missing tool.

Typical installation on a Debian/Ubuntu server:

sudo apt-get install jpegoptim optipng pngquant gifsicle webp ghostscript ffmpeg
sudo npm install -g svgo

Settings: API Credentials

Cloud engines only need an API key, entered under Settings → Images → API credentials (a “Get your API key” link is shown under each field):

The keys are stored in the database (settings table).

Serving Optimized Files: Rewrite Rules

The rewrite rules make the web server serve, for every request under /storage/:

1. the WebP variant when the browser accepts WebP and a .webp sibling exists (with the correct Content-Type and a Vary: Accept header for caches),
2. otherwise the optimized copy when it exists,
3. otherwise the original file, exactly as before.

Manage everything from Settings → Rewrite rules: detected web server, rules status, install / remove buttons, live probe and ready-to-copy snippets.

Apache / LiteSpeed

The rules are written automatically into public/.htaccess, inside a clearly delimited block (# BEGIN FileOptimizer … # END FileOptimizer):

• installed when the add-on is activated,
• refreshed when the settings are saved,
• removed when the add-on is deactivated or removed.

You can also install/remove the block manually with the buttons on the settings page.

Nginx

Nginx cannot be configured automatically from PHP. The settings page generates a ready-to-paste snippet (a map block for the http {} context and a location block for your server {} context). Paste it into your server configuration, run nginx -t and reload nginx.

Testing the Rules (Live Probe)

Click Test the rules (live probe): the add-on creates a temporary probe file plus an “optimized” copy, requests the public URL over HTTP, and reports which variant your web server actually returned — including whether the WebP variant is delivered. This works on any server type and is the definitive check that everything is wired correctly.

Console Commands

# Index the storage (same as the Scan button)
php artisan fileoptimizer:scan

# Optimize every pending file (all types, or one type, optionally capped)
php artisan fileoptimizer:optimize
php artisan fileoptimizer:optimize --type=image
php artisan fileoptimizer:optimize --type=pdf --limit=100

Typical cron automation (scan then optimize new files nightly):

0 3 * * * cd /path/to/your/site && php artisan fileoptimizer:scan && php artisan fileoptimizer:optimize >> /dev/null 2>&1

Queue Workers

When QUEUE_CONNECTION is set to database, redis, etc., and the processing mode is Automatic or Queue, bulk runs dispatch one job per file on the fileoptimizer queue. Make sure your worker listens to it:

php artisan queue:work --queue=fileoptimizer,default

No worker? Keep the Automatic mode: the browser-driven loop needs nothing but an open admin page.

Deactivation & Removal

• Deactivate — the rewrite rules are removed from .htaccess; originals are served again. The catalog, settings and optimized copies are kept, so re-activating restores everything.
• Remove — additionally drops the add-on tables, deletes the whole mirror folder (_optimized) and the add-on files. Your original files are untouched.

Uninstallation

Switching an add-on off without losing anything is a deactivation: go to Admin panel → Add-ons, find File Optimizer and click Deactivate.

• Its routes, views, admin menu entries and permissions stop being registered, and its front-end pages stop answering.
• Its database tables and all the data they hold are kept, and its files stay under extensions/addons/fileoptimizer/. Nothing is deleted.
• The purchase code recorded at activation is kept too, so activating the add-on again does not ask for it.
• Deactivation is refused while another active add-on depends on this one: deactivate that add-on first.

Click Activate on the same card to switch it back on. Pending migrations are re-run, assets are republished, and the add-on picks up exactly where it left off.

Removing

Removing is permanent and destroys the add-on's data. The Remove button only appears on a deactivated add-on, so removal is always two steps:

1. Deactivate File Optimizer (see Uninstallation).
2. Click Remove on its card and confirm the prompt.

The admin panel then, in one pass:

• runs the add-on's uninstall hook, if it ships one, while its code is still on disk;
• revokes the permissions declared in its addon.json;
• rolls back its migrations — this drops its database tables and every row they hold — and purges its entries from the migrations table, so a later reinstall migrates from scratch;
• deletes its published assets: public/addons/fileoptimizer/, public/vendor/fileoptimizer/ and storage/app/public/addons/fileoptimizer/;
• deletes the add-on directory extensions/addons/fileoptimizer/;
• deletes its row in the addons table (the recorded purchase code goes with it) and clears the application cache.

Removal is refused, with an explanatory message and before anything is destroyed, when the add-on is still active, when another active add-on depends on it, or when the web server (PHP) user cannot delete extensions/addons/fileoptimizer/. In that last case, give that user write permission on the directory and on its parent, then try again.

Deleting the folder over FTP or SSH is not equivalent: the add-on's tables, its entries in the migrations table and its addons row are all left behind, and its card stays in the list. Use Remove in the admin panel instead.

Troubleshooting

Files fail with “engine is not configured”

The selected engine needs binaries or credentials that are missing. Run Check binaries on the settings page, install the missing tools (links are provided under each field) or switch to a cloud engine and enter its API key.

The probe says optimized copies are NOT served

• Apache: check that the block is installed (Settings → Rewrite rules), that mod_rewrite and AllowOverride All are enabled, and that public/.htaccess is writable.
• Nginx: paste the generated snippet, run nginx -t, reload, probe again.

“Could not write public/.htaccess”

Fix the file permissions so PHP can write it (e.g. chown www-data public/.htaccess or chmod 664), then click Install the rules again.

Bulk run doesn’t progress in queue mode

Your worker is not running or not listening to the fileoptimizer queue. Start it (see Queue Workers) or switch the processing mode to Browser-driven and relaunch.

Most images end up “Skipped”

They are already well compressed — the result did not beat the Minimum savings threshold. That is by design (serving a barely-smaller copy is not worth it). Try the Aggressive level or enable WebP for extra savings.

A file changed but the old optimized version shows

Run a Scan: modified files are detected by size/date, their stale copies are deleted immediately and they are queued for re-optimization.

FAQ

Are my original files modified?

Never. Optimized copies live in a separate mirror folder; delete them at any time to serve the originals again.

What happens if I disable the add-on?

The rewrite rules are removed and the site serves the original files, exactly as before the add-on was installed. Nothing else changes.

Does it work on shared hosting?

Yes. The browser-driven mode needs no queue worker and no shell access; the reSmush.it engine even works without any binary or paid API. Only the .htaccess file must be writable for automatic rule installation.

Will WebP break browsers that don’t support it?

No. The WebP variant is only served when the browser explicitly advertises support via its Accept header; everyone else receives the original format. The Vary: Accept header keeps proxies and CDNs correct.

How much CPU does it use?

Work happens in short steps (a few files at a time) precisely so the front-end never slows down. Video/audio transcoding is heavier — that is why it is disabled by default and best run through a queue worker or cron at night.

File Optimizer v1.0.0 · LaraClassifier / JobClass Add-on · by BeDigit