README

This package is built on Laravel Sidecar and ClamAVNet, it provides a very easy way to deploy a robust virus scanning capability for your Laravel applications.

Installation

This package requires that hammerstone/sidecar has been installed in your Laravel application.

You can install the package via composer:

composer require statix-php/sidecar-virus-scan

You can optionally publish the config file with:

php artisan vendor:publish --tag="sidecar-virus-scan-config"

This is the contents of the published config file:

return [
    //
];

/*
 * All of your function classes that you'd like to deploy go here.
 */
'functions' => [
    \Statix\VirusScan\Functions\ScanForVirusFunction::class,
],

Deploy the Lambda function by running:

php artisan sidecar:deploy --activate

See Sidecar documentation for details.

Usage

$virusScan = new Statix\VirusScan();

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

statix-php / sidecar-virus-scan

Maintainers

Details