Statamic Auto Alt Text

Automatically generate descriptive alt text for images in Statamic v5 using AI services (Moondream or OpenAI GPT-4 Vision)

Features

Automatic Generation: Generate alt text for assets using AI by listening for Statamic asset events
Multiple AI Providers: Support for Moondream (cloud or self-hosted) and OpenAI (GPT-4 Vision)
Data Privacy: Option to use local Moondream endpoints, keeping image data within your infrastructure
Control Panel Integration: Field Action to generate alt text for individual images
Bulk Processing: Artisan Command for processing images individually or in batch

Installation


composer require el-schneider/statamic-auto-alt-text

Publish the configuration file:


php artisan vendor:publish --tag="statamic-auto-alt-text-config"

Configuration

By default, the addon uses the moondream service with the cloud API. Set your API key in your .env file:

MOONDREAM_API_KEY=your_api_key_here

Refer to the published configuration file (config/statamic/auto-alt-text.php) for additional options, including switching between services.

Non-English Captions

Moondream

Currently, Moondream only supports English language captions. If you need captions in other languages, consider using the OpenAI service instead.

OpenAI

OpenAI supports multiple languages. You can customize the prompt to generate captions in your preferred language by setting the OPENAI_PROMPT environment variable:

OPENAI_PROMPT="Beschreibe dieses Bild kurz und bündig, um einen Alternativtext für Barrierefreiheit bereitzustellen. Bitte antworte ausschließlich mit dem Alt-Text, keine Einleitung oder Erläuterungen."

Usage

Automatic Generation

The addon listens for configured Statamic events (default: AssetUploaded and AssetSaving). When an asset without alt text is detected, a background job is dispatched to generate it automatically using your configured AI service.

Important: This feature requires Laravel's queue system with an asynchronous queue driver (e.g., database, redis, sqs) and a running queue worker (php artisan queue:work). The default sync driver won't work for background processing.

Optionally customize the queue configuration:

Optional: Defaults to your application's default queue connection

AUTO_ALT_TEXT_QUEUE_CONNECTION=redis

Optional: Defaults to the default queue name for the connection

AUTO_ALT_TEXT_QUEUE_NAME=alt_text_generation

Manual Generation

For existing assets or specific workflows:

Field Action: Edit an asset, find the alt text field, and click the "Generate Alt Text" action
Statamic Action: In an Asset container, use the "Generate Alt Text" action from the contextual menu
CLI Command: Process assets in bulk with:
```
php artisan auto-alt:generate
```
See php artisan auto-alt:generate --help for options to specify containers, assets, and overwriting behavior

Using Local Moondream

For privacy or compliance reasons, you can run Moondream locally:

Set up Moondream: Follow the Quickstart guide to set up a local Moondream server
Configure the addon: Update your .env file:

Set your local server endpoint (default points to cloud API)

MOONDREAM_ENDPOINT=http://your-local-moondream-server:port/v1/caption

You may not need an API key for local setups (remove or leave empty if not required)

MOONDREAM_API_KEY=