hapi-tus-node-server

HAPI-compatible fork of tus-node-server.

tus is a new open protocol for resumable uploads built on HTTP. This is the tus protocol 1.0.0 node.js server implementation.

Installation

$ npm install hapi-tus-node-server

Quick Start

Use tus-node-server with Hapi

const Hapi = require('@hapi/hapi')
const HapiTus = require('hapi-tus-node-server');

const port = 1080;
const host = '127.0.0.1'; // or '0.0.0.0' to listen on all interfaces

const initServer = async () => {

  const server = Hapi.server({
    port: port,
    host: host
    routes: {
      payload: {
        allow: ['application/json', 'application/x-www-form-urlencoded', 'application/offset+octet-stream', 'multipart/form-data']
      }
    }
  });

  let tusOptions = {
    limits: {
      maxRequestSizeInMegabytes: 60
    },
    datastore: new HapiTus.FileStore({
      path: '/files',
      absoluteLocation: 'http://127.0.0.1:1080'
    });
  };

  await server.register({ plugin: HapiTus, options: tusOptions } );
  await server.start();
  console.log(`[${new Date().toLocaleTimeString()}] tus server listening at %s using FileStore`, server.info.uri);
};

process.on('unhandledRejection', (err) => {
  console.log(err);
  process.exit(1);
});

initServer();

Flexible Data Stores

• Local File Storage

  tusOptions.datastore = new HapiTus.FileStore({
      path: '/files'
  });

• Google Cloud Storage

  
  tusOptions.datastore = new HapiTus.GCSDataStore({
      path: '/files',
      projectId: 'project-id',
      keyFilename: 'path/to/your/keyfile.json',
      bucket: 'bucket-name',
  });

• Amazon S3

  
  tusOptions.datastore = new HapiTus.S3Store({
      path: '/files',
      bucket: 'bucket-name',
      accessKeyId: 'access-key-id',
      secretAccessKey: 'secret-access-key',
      region: 'eu-west-1',
      partSize: 8 * 1024 * 1024, // each uploaded part will have ~8MB,
      tmpDirPrefix: 'tus-s3-store',
  });

Development

Start the demo server using Local File Storage

$ npm run demo

Or start up the demo server using Google Cloud Storage

$ npm run gcs_demo

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

Environment Variables in .env file

An example .env.example file is provided, which can be renamed to .env if you do not wish to set environment variables in your shell manually.

TUS_PUBLIC_SITE=http://127.0.0.1:1080
TUS_PUBLIC_PATH=/files
TUS_LOCAL_PATH=/files