README

Imgproxy Bundle for Symfony

A Symfony bundle that integrates imgproxy with Liip Imagine Bundle, replacing on-the-fly image processing with imgproxy's powerful and performant image transformation service.

Features

• 🚀 Drop-in replacement for Liip Imagine Bundle - no template changes needed
• ⚡ High performance - leverage imgproxy's native Go implementation
• 🔒 Secure - URL signing support to prevent unauthorized image transformations
• 📦 S3/CDN ready - works seamlessly with cloud storage
• 🎨 Full filter support - supports 13/17 Liip Imagine filters (76% compatibility)
• 🔧 Static asset detection - automatically skips webpack builds and bundles

Requirements

• PHP 8.0, 8.1, 8.2, 8.3, or 8.4
• Symfony 5.4, 6.4, or 7.1
• Liip Imagine Bundle 2.x
• Running imgproxy server

Installation

Step 1: Install the bundle

composer require 3brs/imgproxy-bundle

Step 2: Register the bundle

Register the bundle in config/bundles.php:

return [
    // ...
    ThreeBRS\ImgproxyBundle\ThreeBRSImgproxyBundle::class => ['all' => true],
];

Step 3: Configure imgproxy

Create config/packages/three_brs_imgproxy.yaml:

imports:
    - { resource: "@ThreeBRSImgproxyBundle/Resources/config/packages/three_brs_imgproxy.yaml" }

Step 4: Set environment variables

# Imgproxy server URL
IMGPROXY_URL=https://imgproxy.your-domain.com

# Source images URL (your S3/CDN endpoint)
IMGPROXY_SOURCE_URL=https://your-bucket.s3.amazonaws.com

# S3 prefix path (optional, leave empty if images are in bucket root)
IMGPROXY_SOURCE_PREFIX=media/image

# Optional: URL signing keys
IMGPROXY_KEY=your_hex_key_here
IMGPROXY_SALT=your_hex_salt_here

Step 5: Update Liip Imagine configuration

In config/packages/liip_imagine.yaml, change the cache resolver:

liip_imagine:
    resolvers:
        imgproxy:
            # Resolver is auto-configured by the bundle

    cache: imgproxy  # Change from 'default' to use imgproxy resolver

    filter_sets:
        # Your existing filter sets...
        thumbnail:
            filters:
                thumbnail: { size: [300, 200], mode: outbound }

Step 6: Clear cache

php bin/console cache:clear

Production deployment

See imgproxy documentation for Kubernetes, AWS ECS, or other deployment options.

Filter Compatibility

✅ Fully Supported (13/17 filters)

⚠️ Partially Supported

• relative_resize - May be imprecise (requires source dimensions)

❌ Not Supported

• flip - No native imgproxy support (use CSS transform)
• paste - Complex compositing not supported
• resample - DPI changes irrelevant for web

Usage

No changes to your templates are needed! All existing imagine_filter calls work automatically:

{# Works exactly as before #}
<img src="{{ asset('/media/image.jpg')|imagine_filter('thumbnail') }}" />

{# With responsive images #}
<picture>
    <source srcset="{{ asset('/media/image.jpg')|imagine_filter('thumbnail_webp') }}" type="image/webp">
    <img src="{{ asset('/media/image.jpg')|imagine_filter('thumbnail') }}" />
</picture>

How It Works

┌─────────────────┐
│  Twig Template  │
│  imagine_filter │
└────────┬────────┘
         │
         v
┌─────────────────────┐
│   Imgproxy Bundle   │
│  (Cache Resolver)   │
└────────┬────────────┘
         │
         v
┌─────────────────────┐      ┌──────────────┐
│  Imgproxy Server    │◄─────│  S3 / CDN    │
│  (Image Processing) │      │  (Source)    │
└────────┬────────────┘      └──────────────┘
         │
         v
┌─────────────────────┐
│   Generated URL     │
│   (Signed/Unsigned) │
└─────────────────────┘

Example Generated URLs:

# Without signing (development)
https://imgproxy.example.com/insecure/resize:fill:300:200/plain/s3-bucket.com/image.jpg

# With signing (production)
https://imgproxy.example.com/AbC123.../resize:fill:300:200/plain/s3-bucket.com/image.jpg

Performance Benefits

Using imgproxy provides significant performance improvements:

• ⚡ Native Go Performance - Up to 10x faster than PHP-based image processing
• 🔄 On-the-fly Processing - No need to pre-generate image variations
• 💾 Reduced Storage - Store only original images, generate variants on demand
• 🌐 CDN Compatible - imgproxy URLs can be cached by CDN for global distribution

Static Assets

The bundle automatically detects and skips static assets (webpack builds, bundles):

• /build/** - webpack encore assets
• /bundles/** - Symfony bundle assets
• /assets/** - general static files

These are returned without imgproxy processing.

Development

Setting up Development Environment

1. Clone the repository:

git clone https://github.com/3BRS/imgproxy-bundle.git
cd imgproxy-bundle

1. Install dependencies:

composer install

1. Start Docker environment:

make up

Available Make Commands

Run make help to see all available commands:

make install          # Install composer dependencies
make test             # Run all tests (PHPUnit + ECS + PHPStan + Deptrac)
make phpunit          # Run PHPUnit tests
make phpunit-coverage # Run tests with coverage report
make ecs              # Check code style
make ecs-fix          # Fix code style issues
make phpstan          # Run static analysis
make deptrac          # Run architecture analysis (requires PHP 8.1+)
make rector           # Check for automated refactoring opportunities
make rector-fix       # Apply automated refactorings
make audit            # Check for security vulnerabilities (optional)
make bash             # Connect to PHP container

Testing

Run the complete test suite:

# Run all quality checks
make test

# Or run individually
make phpunit          # Unit tests
make ecs              # Code style check
make phpstan          # Static analysis
make deptrac          # Architecture analysis (PHP 8.1+)

Test Suite

The project has comprehensive test coverage with 106 tests and 381 assertions:

# Run all tests
make phpunit

# Run only unit tests
make phpunit-unit

# Run only integration tests
make phpunit-integration

# Generate HTML coverage report
make phpunit-coverage

# Coverage report will be in var/coverage/index.html

Test Coverage:

• ✅ Unit Tests - All components (URL builder, filter converter, cache resolver)
• ✅ Integration Tests - Full Symfony kernel with Liip Imagine integration
• ✅ 106 tests with 381 assertions (100% passing)
• ✅ Infection mutation testing for code quality verification

Code Modernization with Rector

Rector automatically refactors code to modern PHP standards:

# Check for refactoring opportunities
make rector

# Apply automated improvements
make rector-fix

What Rector improves:

• ✅ Constructor property promotion (PHP 8.0+)
• ✅ Early returns for better readability
• ✅ Type declarations
• ✅ Dead code removal
• ✅ Symfony/PHPUnit best practices

Notes:

• Rector maintains PHP 8.0 compatibility while using modern syntax
• Rector requires PHPStan 1.x, which doesn't support PHP 8.4
• On PHP 8.4, use PHPStan 2.x instead (Rector will be unavailable)

Security Audit

Note: Security audit is primarily useful for applications, not libraries/bundles.

This bundle doesn't commit composer.lock, so the audit only checks development dependencies.

For bundle developers:

make audit  # Optional: checks dev dependencies (PHPStan, ECS, etc.)

For application developers using this bundle:

Always run security audit in your application to check all dependencies including this bundle:

# In your Symfony application
composer audit

The audit checks dependencies against the PHP Security Advisories Database.

Continuous Integration

The project uses CircleCI to test against multiple PHP and Symfony versions:

• PHP versions: 8.0, 8.1, 8.2, 8.3, 8.4
• Symfony versions: 5.4, 6.4, 7.1
• Dependency strategies: --prefer-lowest and --prefer-stable

Each CI build runs:

1. PHPUnit - 106 tests with 381 assertions (unit + integration)
2. ECS - Code style checks (PSR-12)
3. PHPStan - Static analysis (level 8)
4. Deptrac - Architecture validation (PHP 8.1+ only)
5. Rector - Code modernization checks (PHP 8.0-8.3)
6. Infection - Mutation testing for code quality

Architecture Layers:

The project uses Deptrac to enforce clean architecture:

• Bundle - Main bundle class (can depend on all layers)
• DependencyInjection - Service configuration (can depend on Imagine)
• Imagine - Core business logic (independent, no external dependencies)

Version-specific tools:

• PHP 8.0: Deptrac skipped (requires PHP 8.1+)
• PHP 8.4: Rector skipped (PHPStan 2.x required for PHP 8.4, which conflicts with Rector 1.x)

Contributing

We welcome contributions! Please follow these guidelines:

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Make your changes
4. Run tests (make test)
5. Commit your changes (git commit -m 'Add amazing feature')
6. Push to the branch (git push origin feature/amazing-feature)
7. Open a Pull Request

Code Quality Standards

All contributions must pass our quality gates:

• PSR-12 coding standards (enforced by ECS)
• PHPStan level 8 static analysis
• Deptrac architecture validation (PHP 8.1+)
• Rector code modernization (optional but recommended)
• Write meaningful commit messages
• Add tests for new features

Before submitting:

make test         # Run all quality checks
make rector       # Check for refactoring opportunities
make rector-fix   # Apply automated improvements (optional)

License

This project is licensed under the MIT License.

Credits

Developed and maintained by 3BRS

Support

• 🐛 Report bugs
• 💡 Request features
• 📖 Imgproxy Documentation
• 📖 Liip Imagine Bundle Documentation