A Flysystem Driver for elFinder

v0.5.0 2024-03-09 18:52 UTC


This package adds a VolumeDriver for elFinder to use Flysystem as a root in your system. You need to have elFinder 2.1 installed. You can download the source or nightlies from or use the Laravel version:

Require this package in your composer.json and update composer.

composer require barryvdh/elfinder-flysystem-driver

This will require Flysystem, but you might need additional adapters to fit your purpose. See for more information.

Basic usage

You can use the driver by setting the connector config to Flysystem.

'roots' => [
        'driver' => 'Flysystem', 
        'path' => 'images',
        'URL' => '/images', 
        'filesystem' => new Filesystem(new LocalAdapter('/path/to/public_html')),
        'cache' => 'session', // 'session', 'memory' or false
        'driver' => 'Flysystem',
        'URL' => '',
        'alias' => '',
        'filesystem' => new Filesystem(new FtpAdapter(
                    'host' => '',
                    'username' => 'user',
                    'password' => '****',
                    'root' => '/domains/',
        'driver' => 'Flysystem',
        'adapter' => new DropboxAdapter(new Dropbox\Client($token, $appName))

The path and URL options are optional. The path defaults to '/', the URL is only possible when the file is visible through an URL.

Displaying thumbnails/images through Glide

If you require Glide, you can show thumbnails for your images and generate secure urls.

    'driver' => 'Flysystem', 
    'filesystem' => $fs,
    'glideURL' => '',
    'glideKey' => 'your-sign-key',

You can still use the tmbSize and tmbCrop options from the configuration options

This will require you to setup a basic server with Glide, see A signKey is optional, but can help secure your images against changing parameters.

Note: When securing image, you need to remove the _ parameter from your Request object: $request->query->remove('_'); Otherwise the signature will fail. The _ parameter is used to disable caching.


This elFinder driver is open-sourced software licensed under the MIT license