Tusflow

Getting Started

Tusflow API is an open-source, high-performance implementation of the TUS (resumable upload) protocol built on Cloudflare Workers. It provides enterprise-grade file upload infrastructure with built-in support for resumable uploads, chunking, and advanced security features.

Key Features

Resumable Uploads

Built-in support for pause, resume and automatic recovery of uploads

Edge Computing

Powered by Cloudflare Workers for optimal global performance

Enterprise Security

Robust protection with rate limiting, API authentication, file validation, and secure headers

Observability

Monitor API health and performance with built-in observability features

Chunk Management

Smart file chunking with parallel uploads and automatic optimization

Storage Integration

Direct integration with S3-compatible storage services

Why Tusflow?

  1. High Performance

    • Powered by Cloudflare's global edge network for low latency and high-speed uploads.

  2. Developer Experience

    • Simple and intuitive integration with comprehensive documentation and starter templates.

  3. Enterprise Ready

    • Built with production-grade security, reliability, and scalability features to handle critical workloads.

  4. Open Source

    • Fully MIT licensed and community-driven, ensuring transparency and the freedom to customize.

  5. Protocol Compliant

    • Implements the full TUS v1.0.0 protocol for resumable file uploads, ensuring compatibility and reliability.

  6. Cost Efficiency

    • Designed to allow developers to self-host and deploy their own upload services, eliminating reliance on costly third-party solutions.

Quick Start Guide

Installation

# Clone the repository
git clone https://github.com/Tusflow/tusflow-api
 
# Install dependencies
npm install
 
# Configure environment
 
 
# Deploy to Cloudflare Workers
npm run deploy

Documentation

Configuration

Learn how to configure and customize Tusflow

Middleware

Authentication, rate limiting and other middleware options

Features

Explore Tusflow's advanced features and capabilities

Community & Support

Edit on GitHub

Last updated on

Next

Configuration

On this page