2013-05-02 12:48:04 +00:00
|
|
|
# tusd
|
2013-03-16 21:23:25 +00:00
|
|
|
|
2016-11-08 15:33:42 +00:00
|
|
|
<img alt="Tus logo" src="https://github.com/tus/tus.io/blob/master/assets/img/tus1.png?raw=true" width="30%" align="right" />
|
|
|
|
|
|
2016-03-11 20:50:00 +00:00
|
|
|
> **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 by accident in case of an network issue or server
|
|
|
|
|
> outage.
|
2015-02-01 14:45:27 +00:00
|
|
|
|
2013-05-02 12:48:04 +00:00
|
|
|
tusd is the official reference implementation of the [tus resumable upload
|
2015-07-15 12:40:14 +00:00
|
|
|
protocol](http://www.tus.io/protocols/resumable-upload.html). 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.
|
2013-03-16 21:25:33 +00:00
|
|
|
|
2018-02-16 22:17:13 +00:00
|
|
|
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 tusd.
|
|
|
|
|
|
2015-02-01 13:57:57 +00:00
|
|
|
**Protocol version:** 1.0.0
|
2013-03-16 21:23:25 +00:00
|
|
|
|
2019-09-20 14:47:22 +00:00
|
|
|
This branch contains tusd v1. If you are looking for the previous major release, after which
|
|
|
|
|
breaking changes have been introduced, please look at the [0.14.0 tag](https://github.com/tus/tusd/tree/0.14.0).
|
|
|
|
|
|
2019-09-29 19:15:31 +00:00
|
|
|
## Documentation
|
2013-03-17 15:45:09 +00:00
|
|
|
|
2019-09-29 19:15:31 +00:00
|
|
|
* [Installation](/docs/installation.md)
|
|
|
|
|
* [Using the `tusd` binary](/docs/usage-binary.md)
|
|
|
|
|
* [Monitoring the server](/docs/monitoring.md)
|
|
|
|
|
* [Receiving events with hooks](/docs/hooks.md)
|
|
|
|
|
* [Using the tusd package programmatically](/docs/usage-package.md)
|
|
|
|
|
* [FAQ & Common issues](/docs/faq.md)
|
2016-03-11 20:50:00 +00:00
|
|
|
|
2019-09-29 19:15:31 +00:00
|
|
|
## Build status
|
2013-05-10 14:46:58 +00:00
|
|
|
|
2021-10-24 08:04:14 +00:00
|
|
|
[](https://github.com/tus/tusd/actions/workflows/release.yaml)
|
|
|
|
|
[](https://github.com/tus/tusd/actions/workflows/continuous-integration.yaml)
|
2016-03-11 20:50:00 +00:00
|
|
|
|
2013-03-16 21:23:25 +00:00
|
|
|
## License
|
|
|
|
|
|
2013-04-16 10:26:29 +00:00
|
|
|
This project is licensed under the MIT license, see `LICENSE.txt`.
|
