README.md

Documentation Index

I want to use the library

1. README: what it is, quick start (Spring Boot, plain Servlet, curl)
2. Integration Guide: process(), completion handling, cleanup, security, frontend clients
3. Configuration Reference: all options and storage backend choice
4. Deployment Guide: multi-replica, reverse proxies, containers
5. Troubleshooting
6. Architecture Guide: system structure, protocol extensions, storage SPI, and distributed locking

Protocols

• Protocols: Tus 1.0.0 & IETF RUFH flows, comparison, extensions, digests
• Migrating clients to RUFH: header mapping and request examples
• HTTP 104 Interim Responses

Upgrading

• Upgrade Guide 1.x → 2.0 and the CHANGELOG

Storage & locking

• Locking concepts & custom lock services
• Disk & network storage (NFS, EFS, SMB)
• S3-compatible storage
• Azure Blob Storage
• Upload Deduplication & Migration

Contributors & maintainers

• Architecture Guide, CONTRIBUTING, Testing guide, Conformity testing, Release process