Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

344 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tusdotnet

NuGet NuGet codecov

"Our aim is to solve the problem of unreliable file uploads once and for all. tus is a new open protocol for resumable uploads built on HTTP. It offers simple, cheap and reusable stacks for clients and servers. It supports any language, any platform and any network." - https://tus.io

tusdotnet is a .NET server implementation of the tus.io protocol that runs on .NET Framework, .NET Standard, .NET 6 and later.

Features

  • Runs on .NET Framework, .NET Standard 1.3+ and .NET 6+ using OWIN or ASP.NET Core
  • Full support for tus 1.0.0 including all major extensions (checksum, checksum-trailers, concatenation, creation, creation-with-upload, upload-defer-length, expiration and termination)
  • Experimental support for IETF's Resumable Uploads For Http (see branch POC/tus2)
  • Fast and reliable
  • Easy to configure
  • Customizable data storage (see Storage)
  • MIT licensed

Getting started

dotnet add package tusdotnet
using tusdotnet;

var builder = WebApplication.CreateBuilder(args);
var app = builder.Build();

app.MapTus("/files", async httpContext => new()
{
    // This method is called on each request so different configurations can be returned per user, domain, path etc.
    // Return null to disable tusdotnet for the current request.

    // Where to store data?
    Store = new tusdotnet.Stores.TusDiskStore(@"C:\tusfiles\"),
    Events = new()
    {
        // What to do when the file is completely uploaded?
        OnFileCompleteAsync = async eventContext =>
        {
            var file = await eventContext.GetFileAsync();

            await QueueForProcessing(file);
        }
    }
});

Depending on your infrastructure you might also need to configure Kestrel, IIS or other reverse proxies.

More options, events and middleware usage are available on the wiki.

Storage

Store Type Description
TusDiskStore Built-in Saves files to a local directory
Xtensible.TusDotNet.Azure Community Azure Blob Storage
tusdotnet.Storage.S3 Community S3-compatible storage (AWS S3, MinIO, Cloudflare R2, etc.)

You can also write your own store.

Try it out

Clone the repo and run one of the test sites. They each launch a small site running tusdotnet and the official JS client so that you can test the protocol on your own machine.

Clients

tus.io keeps a list of clients for a number of different platforms (Android, Java, JS, iOS etc). tusdotnet should work with all of them as long as they support version 1.0.0 of the protocol.

License

This project is licensed under the MIT license, see LICENSE.

About

.NET server implementation of the Tus protocol for resumable file uploads. Read more at https://tus.io

Topics

Resources

Stars

759 stars

Watchers

16 watching

Forks

Releases

Packages

Used by

Contributors

Languages