tusdotnet 2.8.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. .NET Core 3.1 This package targets .NET Core 3.1. The package is compatible with this framework or higher. .NET Standard 1.3 This package targets .NET Standard 1.3. The package is compatible with this framework or higher. .NET Framework 4.5.2 This package targets .NET Framework 4.5.2. The package is compatible with this framework or higher. 
dotnet add package tusdotnet --version 2.8.0                

                    
                

            
NuGet\Install-Package tusdotnet -Version 2.8.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="tusdotnet" Version="2.8.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add tusdotnet --version 2.8.0                

                    
                

            
#r "nuget: tusdotnet, 2.8.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install tusdotnet as a Cake Addin
#addin nuget:?package=tusdotnet&version=2.8.0

// Install tusdotnet as a Cake Tool
#tool nuget:?package=tusdotnet&version=2.8.0

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 both .NET 4.x, .NET Core, .NET6 and later.

Comments, ideas, questions and PRs are welcome!

Features

  • Runs on OWIN and ASP.NET Core (on both .NET Framework, .NET Core, .NET6 and later)
  • 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
  • MIT licensed

Install

Visual Studio

PM> Install-Package tusdotnet

.NET CLI

> dotnet add package tusdotnet

Configure

On .NET6 and later:


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 file is completely uploaded?
        OnFileCompleteAsync = async eventContext =>
        {
            tusdotnet.Interfaces.ITusFile file = await eventContext.GetFileAsync();
            Dictionary<string, tusdotnet.Models.Metadata> metadata = await file.GetMetadataAsync(eventContext.CancellationToken);
            using Stream content = await file.GetContentAsync(eventContext.CancellationToken);

            await DoSomeProcessing(content, metadata);
        }
    }
});

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

More options and events are available on the wiki.

Test sites

If you just want to play around with tusdotnet/the tus protocol, 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.

Test sites are available for:

  • ASP.NET Core 6 (.NET 6.0)
  • ASP.NET Core 3.1 (.NET Core 3.1)
  • ASP.NET Core 3.0 (.NET Core 3.0)
  • ASP.NET Core 2.2 (.NET Core 2.2)
  • ASP.NET Core 2.2 (.NET Framework 4.6.2)
  • ASP.NET Core 2.1 (.NET Core 2.1)
  • OWIN (.NET Framework 4.5.2)

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.

Want to know more?

Check out the wiki or create an issue

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 is compatible. 
.NET Standard netstandard1.3 is compatible.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net452 is compatible.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (16)

Showing the top 5 NuGet packages that depend on tusdotnet:

Package Downloads
Apprio.Enablement.Business.Tokens

Package Description
MSFactory.ToolKits

Package Description
Zxs.Kernel.Core

18f61d170f8995cebb6bf4ef17b100567e490b11
Xtensible.TusDotNet.Azure

An Azure Blob Storage extension for tusdotnet; .NET's most popular implementation of the tus protocol.
Zxs.Kernel.Dapper

18f61d170f8995cebb6bf4ef17b100567e490b11

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on tusdotnet:

Repository Stars
Squidex/squidex
Headless CMS and Content Managment Hub
842549829/Panda
Abp.vNext + EF Core The microservices Open source framework project supports the implementation of message push workflow certification centers based on OAuth2.0
Version Downloads Last updated
2.8.0 182,440 2/1/2024
2.7.2 112,695 11/11/2023
2.7.1 109,324 3/11/2023
2.7.0 235,871 11/9/2022
2.6.2 37,281 9/11/2022
2.6.0 227,490 2/18/2022
2.5.0 91,376 11/16/2021
2.4.0 106,578 5/17/2021
2.3.0 140,652 3/30/2020
2.2.2 7,919 12/17/2019
2.2.1 68,461 6/4/2019
2.2.0 3,535 5/6/2019
2.1.3 5,665 11/16/2018
2.1.2 6,172 6/25/2018
2.1.1 3,376 1/30/2018
2.1.0 2,419 1/3/2018
2.0.0 2,489 11/10/2017
1.4.0 2,327 8/2/2017
1.3.0 2,334 3/19/2017
1.2.0 2,289 1/11/2017
1.1.0 2,190 12/9/2016
1.0.0 2,687 11/17/2016

Release notes at https://github.com/tusdotnet/tusdotnet/releases