Laravel Tus Package with native support of Uppy.js / Laravel Octane

Laravel package for handling resumable file uploads with tus protocol and native Uppy.js support without additional Tus servers.

Installation

You can install the package via composer:

composer require arthurpatriot/laravel-tus

You can publish the config file with (optional):

php artisan vendor:publish --tag="tus-config"

Pruning expired uploads

Don`t forget configure upload_expiration parameter in your config.

Without pruning, the tus uploads can accumulate storage very quickly. To mitigate this, you should schedule the tus:prune Artisan command:

$schedule->command('tus:prune')->hourly()->runInBackground();

Events

This package dispatches the following events:

• TusUploadBeforeCreated: Dispatched before tus file being created. Can be used to validate file size, mime type, etc.
• TusUploadCreated: Dispatched when a new file upload is created.
• TusUploadStarted: Dispatched when a file upload is started.
• TusUploadFinished: Dispatched when a file upload is finished.

You can listen to these events in your EventServiceProvider:

use ArthurPatriot\Tus\Events\TusUploadCreated;

protected $listen = [
    TusUploadCreated::class => [
        \App\Listeners\HandleTusUploadCreated::class,
    ],
    ...
];

Usage with Uppy.js

You can use this package with other tus libraries, package fully implemented with Tus.io protocol RFC.

import Uppy, { debugLogger } from "@uppy/core";
import Tus from "@uppy/tus";

const TUS_ENDPOINT = "https://site.test/tus";
const TUS_LIMIT = 5;
const TUS_CHUNK_SIZE = 20000000;


const uppy = new Uppy({ logger: debugLogger });

uppy.use(Tus, { endpoint: TUS_ENDPOINT, limit: TUS_LIMIT, chunkSize: TUS_CHUNK_SIZE })

Tus Extensions

| Extension | Supported | |----------------------|:---------------------------:| | creation | ✅ | | creation-with-upload | ✅ | | expiration | ✅ | | checksum | ✅ | | termination | ✅ | | concatenation | ❌ (will be added on future) |

Testing

composer test

Changelog

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

Security Vulnerabilities

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

Credits

• Artur Khylskyi
• All Contributors

License

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