tusdotnet 2.6.0

.NET 6.0 .NET Core 3.1 .NET Standard 1.3 .NET Framework 4.5.2
Install-Package tusdotnet -Version 2.6.0
dotnet add package tusdotnet --version 2.6.0
<PackageReference Include="tusdotnet" Version="2.6.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add tusdotnet --version 2.6.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: tusdotnet, 2.6.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. 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.6.0

// Install tusdotnet as a Cake Tool
#tool nuget:?package=tusdotnet&version=2.6.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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 and .NET Core!

Comments, ideas, questions and PRs are welcome 😃

Features

  • Runs on OWIN and ASP.NET Core (on both .NET Framework and .NET Core)
  • Full support for tus 1.0.0 including all major extensions (checksum, concatenation, creation, upload-defer-length, expiration and termination)
  • Fast and reliable
  • Easy to configure
  • Customizable data storage
  • MIT licensed

Install

Visual Studio

PM> Install-Package tusdotnet

.NET CLI

> dotnet add tusdotnet

Configure

Create your Startup class as you would normally do. Add a using statement for tusdotnet and run UseTus on the app builder. More options and events are available on the wiki.


app.UseTus(httpContext => new DefaultTusConfiguration
{
    // 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.

    // c:\tusfiles is where to store files
    Store = new TusDiskStore(@"C:\tusfiles\"),
    // On what url should we listen for uploads?
    UrlPath = "/files",
    Events = new Events
    {
        OnFileCompleteAsync = async eventContext =>
        {
            ITusFile file = await eventContext.GetFileAsync();
            Dictionary<string, Metadata> metadata = await file.GetMetadataAsync(ctx.CancellationToken);
            Stream content = await file.GetContentAsync(ctx.CancellationToken);

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

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.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, create an issue or contact me 😃

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

NuGet packages (4)

Showing the top 4 NuGet packages that depend on tusdotnet:

Package Downloads
MSFactory.ToolKits

Package Description

Zxs.Kernel.Core

c6bfc834e20c4d2a7e81ff4ad78f09c2d9a5b10e

Squidex.Assets.TusAdapter

Squidex Asset Storage

Xtensible.TusDotNet.Azure

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

GitHub repositories (1)

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

Repository Stars
Squidex/squidex
Headless CMS and Content Managment Hub
Version Downloads Last updated
2.6.0 26,369 2/18/2022
2.5.0 33,299 11/16/2021
2.4.0 57,790 5/17/2021
2.3.0 98,456 3/30/2020
2.2.2 6,503 12/17/2019
2.2.1 65,300 6/4/2019
2.2.0 3,192 5/6/2019
2.1.3 5,343 11/16/2018
2.1.2 5,776 6/25/2018
2.1.1 2,947 1/30/2018
2.1.0 2,035 1/3/2018
2.0.0 2,042 11/10/2017
1.4.0 1,962 8/2/2017
1.3.0 2,005 3/19/2017
1.2.0 1,951 1/11/2017
1.1.0 1,873 12/9/2016
1.0.0 2,112 11/17/2016