biigle/sync

BIIGLE module to transfer data between application instances.

v2.5.0 2024-01-25 14:20 UTC

Requires

• ramsey/uuid: ^3.5 || ^4.0

GPL-3.0-only

• Martin Zurowietz

• biigle
• biigle-module

README

This is the BIIGLE module to transfer data between application instances.

Installation

This module is already included in biigle/biigle.

1. Run composer require biigle/sync.
2. Add Biigle\Modules\Sync\SyncServiceProvider::class to the providers array in config/app.php.
3. Run php artisan vendor:publish --tag=public to publish the public assets of this module.
4. Configure a storage disk for the uploaded import files and set the SYNC_IMPORT_STORAGE_DISK variable to the name of this storage disk in the .env file. Example for a local disk:

   'imports' => [
       'driver' => 'local',
       'root' => storage_path('imports'),
   ],

5. Add a daily scheduled command to prune old uploaded import files to app/Console/Kernel.php:

   $schedule->command('sync:prune')->daily();

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.