2013-05-02 12:48:04 +00:00
|
|
|
# tusd
|
2013-03-16 21:23:25 +00:00
|
|
|
|
2013-05-02 12:48:04 +00:00
|
|
|
tusd is the official reference implementation of the [tus resumable upload
|
|
|
|
|
protocol](http://www.tus.io/protocols/resumable-upload.html).
|
2013-03-16 21:23:25 +00:00
|
|
|
|
2013-05-02 12:48:04 +00:00
|
|
|
This means it is meant for client authors to verify their implementations as
|
|
|
|
|
well as server authors who may look at it for inspiration.
|
2013-03-16 23:36:51 +00:00
|
|
|
|
2013-05-02 12:48:04 +00:00
|
|
|
In the future tusd may be extended with additional functionality to make it
|
|
|
|
|
suitable as a standalone production upload server, but for now this is not a
|
|
|
|
|
priority.
|
2013-03-16 21:25:33 +00:00
|
|
|
|
2013-05-02 12:48:04 +00:00
|
|
|
**Protocol version:** 0.1 (upgrade to 0.2 will be ready soon)
|
2013-03-16 21:23:25 +00:00
|
|
|
|
2013-03-17 15:45:09 +00:00
|
|
|
## Getting started
|
|
|
|
|
|
|
|
|
|
**Requirements:**
|
|
|
|
|
|
2013-03-20 13:02:24 +00:00
|
|
|
* [Go 1.0](http://golang.org/doc/install)
|
|
|
|
|
|
|
|
|
|
**Installing tusd:**
|
|
|
|
|
|
|
|
|
|
Clone the git repository and `cd` into it.
|
|
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
git clone git@github.com:tus/tusd.git
|
|
|
|
|
cd tusd
|
|
|
|
|
```
|
2013-03-17 15:45:09 +00:00
|
|
|
|
2013-03-17 15:45:47 +00:00
|
|
|
**Running tusd:**
|
2013-03-17 15:45:09 +00:00
|
|
|
|
2013-03-20 13:02:24 +00:00
|
|
|
Run it with go:
|
2013-03-17 15:45:09 +00:00
|
|
|
|
|
|
|
|
```bash
|
|
|
|
|
go run src/cmd/tusd/*.go
|
|
|
|
|
```
|
|
|
|
|
|
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`.
|
