Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tusdotnet/tusdotnet

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

dotnet-core dotnet-standard file-upload-server file-uploads nuget owin-middleware resumable resumable-upload tus tus-protocol

Last synced: 2 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/tusdotnet/tusdotnet
Owner: tusdotnet
License: mit
Created: 2016-08-19T04:07:13.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2025-01-14T08:09:29.000Z (12 days ago)
Last Synced: 2025-01-16T16:05:21.129Z (9 days ago)
Topics: dotnet-core, dotnet-standard, file-upload-server, file-uploads, nuget, owin-middleware, resumable, resumable-upload, tus, tus-protocol
Language: C#
Homepage:
Size: 22 MB
Stars: 689
Watchers: 19
Forks: 71
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

stars - tusdotnet/tusdotnet
awesome - tusdotnet/tusdotnet - .NET server implementation of the Tus protocol for resumable file uploads. Read more at https://tus.io (C\#)

README

        # tusdotnet

[![NuGet](https://img.shields.io/nuget/v/tusdotnet.svg?color=blue&style=popout-square)](https://www.nuget.org/packages/tusdotnet) [![NuGet](https://img.shields.io/nuget/dt/tusdotnet.svg?color=blue&style=popout-square)](https://www.nuget.org/packages/tusdotnet) [![codecov](https://img.shields.io/codecov/c/github/tusdotnet/tusdotnet.svg?color=blue&style=popout-square)](https://codecov.io/gh/tusdotnet/tusdotnet)

>"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, .NET6 and later.

Comments, ideas, questions and PRs are welcome!

## 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](https://datatracker.ietf.org/doc/draft-ietf-httpbis-resumable-upload/) (see branch [POC/tus2](https://github.com/tusdotnet/tusdotnet/tree/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:

```csharp

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 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](https://github.com/tusdotnet/tusdotnet/wiki/Configure-Kestrel), [IIS](https://github.com/tusdotnet/tusdotnet/wiki/Configure-IIS) or [other reverse proxies](https://github.com/tusdotnet/tusdotnet/wiki/Configure-other-reverse-proxies). 

 

 More options and events are available on the [wiki](https://github.com/tusdotnet/tusdotnet/wiki/Configuration).

On older frameworks, use the tusdotnet middelware


Create your Startup class as you would normally do. Add a using statement for `tusdotnet` and run `UseTus` on the app builder. Depending on your infrastructure you might also need to [configure Kestrel](https://github.com/tusdotnet/tusdotnet/wiki/Configure-Kestrel), [IIS](https://github.com/tusdotnet/tusdotnet/wiki/Configure-IIS) or [other reverse proxies](https://github.com/tusdotnet/tusdotnet/wiki/Configure-other-reverse-proxies).  More options and events are available on the [wiki](https://github.com/tusdotnet/tusdotnet/wiki/Configuration).

```csharp

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 metadata = await file.GetMetadataAsync(eventContext.CancellationToken);

            using Stream content = await file.GetContentAsync(eventContext.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](https://github.com/tus/tus-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](http://tus.io/implementations.html) 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](LICENSE).

## Want to know more?

Check out the [wiki](https://github.com/tusdotnet/tusdotnet/wiki) or create an [issue](https://github.com/tusdotnet/tusdotnet/issues)