README.md

tus-node-server

tus is a protocol based on HTTP for resumable file uploads. Resumable means that an upload can be interrupted at any moment and can be resumed without re-uploading the previous data again. An interruption may happen willingly, if the user wants to pause, or bn accident in case of an network issue or server outage.

tus-node-server is an official implementation of the tus resumable upload protocol. The protocol specifies a flexible method to upload files to remote servers using HTTP. The special feature is the ability to pause and resume uploads at any moment allowing to continue seamlessly after e.g. network interruptions.

It is capable of accepting uploads with arbitrary sizes and storing them locally on disk, on Google Cloud Storage or on AWS S3 (or any other S3-compatible storage system). Due to its modularization and extensibility, support for nearly any other cloud provider could easily be added to tus-node-server

📣 Read the 1.0.0 announcement post: new packages, rewrite in TypeScript, and much more.

Contents

• When should I use this?
• Quick start
• Packages
• Extensions
• Demos
• Types
• Compatibility
• Contribute
• License

When should I use this?

When you want reliable, resumable uploads. Together with a client like tus-js-client or Uppy, you'll have a plug-and-play experience.

tus-node-server in particular makes sense if you want to host a Node.js server or integrate it into your existing one. There are also other mature servers, like tusd, tusdotnet, rustus, and many others.

Quick start

A standalone server which stores files on disk.

const {Server} = require('@tus/server')
const {FileStore} = require('@tus/file-store')

const host = '127.0.0.1'
const port = 1080
const server = new Server({
  path: '/files',
  datastore: new FileStore({directory: './files'}),
})

server.listen({host, port})

A tus server integrated into your existing Node.js server. @tus/server has no dependencies so it can be integrated in any server-side framework. More examples can be found in @tus/server.

const fastify = require('fastify')({ logger: true });
const {Server} = require('@tus/server');
const {FileStore} = require('@tus/file-store');

const tusServer = new Server({
  path: '/files',
  datastore: new FileStore({ directory: './files' })
})

fastify.addContentTypeParser(
    'application/offset+octet-stream', (request, payload, done) => done(null);
);
fastify.all('/files', (req, res) => {
    tusServer.handle(req.raw, res.raw);
});
fastify.all('/files/*', (req, res) => {
    tusServer.handle(req.raw, res.raw);
});
fastify.listen(3000, (err) => {
    if (err) {
        fastify.log.error(err);
        process.exit(1);
    }
});

Packages

• @tus/server. The tus server. Standalone or integrate it into your Node.js server.
• @tus/file-store. Store files on disk.
• @tus/s3-store. Store files on AWS S3.
• @tus/gcs-store. Store files on Google Cloud Storage.
• @tus/azure-store. Store files on Azure.

Extensions

The tus protocol supports optional extensions. Below is a table of the supported extensions.

Extension	file-store	s3-store	gcs-store	azure-store
Creation	✅	✅	✅	✅
Creation With Upload	✅	✅	✅	✅
Expiration	✅	✅	❌	❌
Checksum	❌	❌	❌	❌
Termination	✅	✅	❌	❌
Concatenation	❌	❌	❌	❌

Demos

Start the demo server using Local File Storage

npm run build && npm run demo

Start up the demo server using AWS S3. The environment variables AWS_BUCKET, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_REGION need to be present.

npm run build && npm run demo:s3

Start up the demo server using Google Cloud Storage. A keyfile.json needs to be present in the root of the repository.

npm run build && npm run demo:gcs

Then navigate to the demo (localhost:1080) which uses tus-js-client.

Types

All packages are fully typed with TypeScript.

Compatibility

All packages require Node.js 16.0+.

Contribute

See contributing.md.

License

MIT © tus