2013-03-26 14:45:20 +00:00
|
|
|
# tusd - Let's fix file uploading
|
2013-03-16 21:23:25 +00:00
|
|
|
|
2013-03-26 14:45:20 +00:00
|
|
|
It's 2013, and adding reliable file uploading to your app is still too damn
|
|
|
|
|
hard. tus is an open source project dedicated to create the best file uploading
|
|
|
|
|
protocol, server and clients.
|
2013-03-16 21:23:25 +00:00
|
|
|
|
2013-03-16 23:36:51 +00:00
|
|
|
Sounds interesting? Get notified when it's ready: http://tus.io/
|
|
|
|
|
|
2013-03-16 21:25:33 +00:00
|
|
|
## Roadmap
|
|
|
|
|
|
2013-03-17 11:06:53 +00:00
|
|
|
The initial goal for this project to come up with a good and simple solution
|
|
|
|
|
for resumable file uploads over http.
|
2013-03-16 21:23:25 +00:00
|
|
|
|
2013-03-17 12:08:15 +00:00
|
|
|
* Defining a good http API (first proposal created)
|
|
|
|
|
* Implementing a minimal and robust server for it (in progress)
|
2013-03-26 14:45:20 +00:00
|
|
|
* Creating an HTML5 client (in progress, proof of concept working)
|
|
|
|
|
* Setting up an online demo (done)
|
2013-03-16 21:23:25 +00:00
|
|
|
* Integrating Amazon S3 for storage
|
|
|
|
|
* Creating an iOS client
|
|
|
|
|
|
2013-03-17 11:06:53 +00:00
|
|
|
Future features will be based on [your
|
|
|
|
|
feedback](https://github.com/tus/tusd/issues/new). A few potential ideas:
|
|
|
|
|
|
|
|
|
|
* Alternative transfer mechanisms: FTP, UDP, E-Mail, etc.
|
|
|
|
|
* Security: Authentication Tokens, HTTPS, etc.
|
|
|
|
|
* Support for running tusd instances in a geographically distributed cluster
|
|
|
|
|
(reverse CDN)
|
|
|
|
|
* Alternative storage backends: Cloud Files, Dropbox, etc.
|
|
|
|
|
* More clients: Android, PhoneGap, etc.
|
2013-03-18 16:05:44 +00:00
|
|
|
* Service integrations: Transloadit, Zencoder, Encoding.com, Youtube, Vimeo, Facebook, AWS
|
2013-03-17 14:03:02 +00:00
|
|
|
Transcoder, etc.
|
2013-03-17 11:11:36 +00:00
|
|
|
* File meta data analysis
|
|
|
|
|
* Thumbnail generation
|
2013-03-17 11:06:53 +00:00
|
|
|
|
2013-03-26 14:45:20 +00:00
|
|
|
Once the project matures, we hope to offer a hosted service and support
|
2013-03-17 11:08:24 +00:00
|
|
|
contracts. However, all code will continue to be released as open source, and
|
|
|
|
|
you'll always be able to run your own deployments easily. There will be no bait
|
|
|
|
|
and switch.
|
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`.
|
