README

This is a BIIGLE module that offers private storage disks for users.

Configuration

This module supports s3, webdav, elements and aruna storage disks but by default only S3 is enabled. Configure the enabled storage disk types as a comma-separated list with the USER_DISKS_TYPES environment variable (e.g. s3,webdav).

Required Configuration by Disk Type

Different storage disk types require additional packages to be installed:

• S3: No additional packages required (included by default)
• Aruna: No additional packages required (included by default but disabled)
• Elements: Requires biigle/laravel-elements-storage

  composer require biigle/laravel-elements-storage

• WebDAV: Requires biigle/laravel-webdav

  composer require biigle/laravel-webdav

• Azure: Requires biigle/laravel-azure-storage

  composer require biigle/laravel-azure-storage

Install only the packages for the disk types you plan to enable.

Installation

1. Run composer require biigle/user-disks.
2. Add Biigle\Modules\UserDisks\UserDisksServiceProvider::class to the providers array in config/app.php.
3. Run php artisan vendor:publish --tag=public to refresh the public assets of the modules. Do this for every update of this module.
4. Run php artisan migrate to create the new database tables.

Developing

Take a look at the development guide of the core repository to get started with the development setup.

Want to develop a new module? Head over to the biigle/module template repository.

Contributions and bug reports

Contributions to BIIGLE are always welcome. Check out the contribution guide to get started.