tusproject/tusd

tusd

镜像概述

tusd是tus可恢复上传协议的官方参考实现。tus协议基于HTTP，专为可恢复文件上传设计，允许上传过程在任意时刻中断（如网络故障、用户暂停）后无缝恢复，无需重新上传已传输数据。tusd作为协议的 reference implementation，提供了稳定、灵活的文件上传服务能力。

核心功能与特性

• 断点续传：支持上传过程中断后恢复，核心基于tus协议1.0.0版本规范
• 多存储后端：支持本地磁盘、Google Cloud Storage、AWS S3及兼容S3协议的存储系统
• 无限文件大小：能够处理任意大小的文件上传，无内置容量限制
• 模块化架构：设计 extensible，可通过扩展轻松添加对其他云存储服务的支持
• 跨平台兼容：作为HTTP服务，可与任何支持tus协议的客户端集成

使用场景与适用范围

tusd适用于需要可靠文件上传能力的各类场景：

• 大文件上传场景（如视频、备份文件、数据集传输）
• 网络环境不稳定的文件传输（如移动端上传、弱网环境）
• 需要断点续传功能的应用（内容管理系统、云存储服务、协作平台）
• 多存储后端需求的企业级应用（可灵活切换存储策略）

使用方法与配置说明

基本运行示例

使用本地存储后端启动tusd服务：

bash
docker run -d \
  -p 8080:8080 \
  -v /host/path/to/storage:/srv/tusd \
  --name tusd-service \
  tusd/tusd

参数说明：

• -p 8080:8080：映射容器8080端口到主机（默认服务端口）
• -v /host/path/to/storage:/srv/tusd：挂载主机目录作为本地存储卷（本地存储模式必填）
• --name tusd-service：指定容器名称便于管理

环境变量配置

通过环境变量配置存储后端及服务参数：

高级配置示例

AWS S3存储后端配置

bash
docker run -d \
  -p 8080:8080 \
  -e STORAGE_TYPE=s3 \
  -e S3_ACCESS_KEY=AKIAEXAMPLE \
  -e S3_SECRET_KEY=secretkeyexample \
  -e S3_BUCKET=my-tus-uploads \
  -e S3_REGION=us-west-2 \
  tusd/tusd

Docker Compose配置

yaml
version: '3.8'
services:
  tusd:
    image: tusd/tusd
    ports:
      - "8080:8080"
    volumes:
      - ./local-storage:/srv/tusd  # 本地存储时启用
    environment:
      - STORAGE_TYPE=local
      - PORT=8080
      - LOCAL_STORAGE_PATH=/srv/tusd
    restart: unless-stopped

文档与资源

• https://github.com/tus/tusd/tree/master/docs
  • https://github.com/tus/tusd/blob/master/docs/installation.md
  • https://github.com/tus/tusd/blob/master/docs/monitoring.md
  • https://github.com/tus/tusd/blob/master/docs/hooks.md%EF%BC%88%E4%B8%8A%E4%BC%A0%E7%8A%B6%E6%80%81%E5%8F%98%E6%9B%B4%E9%80%9A%E7%9F%A5%EF%BC%89

许可证

本项目采用MIT许可证，详情参见https://github.com/tus/tusd/blob/master/LICENSE.txt%E3%80%82