Merge pull request #220 from lucab85/20181121

Fix typos
This commit is contained in:
Marius 2018-11-23 11:38:38 +00:00 committed by GitHub
commit f46d660073
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 6 deletions

View File

@ -33,7 +33,7 @@ Windows in various formats of the
The only requirement for building tusd is [Go](http://golang.org/doc/install) 1.5 or newer. The only requirement for building tusd is [Go](http://golang.org/doc/install) 1.5 or newer.
If you meet this criteria, you can clone the git repository, install the remaining If you meet this criteria, you can clone the git repository, install the remaining
depedencies and build the binary: dependencies and build the binary:
```bash ```bash
git clone git@github.com:tus/tusd.git git clone git@github.com:tus/tusd.git
@ -48,7 +48,7 @@ go build -o tusd cmd/tusd/main.go
## Running tusd ## Running tusd
Start the tusd upload server is as simple as invoking a single command. For example, following Start the tusd upload server is as simple as invoking a single command. For example, following
snippet demostrates how to start a tusd process which accepts tus uploads at snippet demonstrates how to start a tusd process which accepts tus uploads at
`http://localhost:1080/files/` and stores them locally in the `./data` directory: `http://localhost:1080/files/` and stores them locally in the `./data` directory:
``` ```
@ -171,7 +171,7 @@ func main() {
// A storage backend for tusd may consist of multiple different parts which // A storage backend for tusd may consist of multiple different parts which
// handle upload creation, locking, termination and so on. The composer is a // handle upload creation, locking, termination and so on. The composer is a
// place where all those seperated pieces are joined together. In this example // place where all those separated pieces are joined together. In this example
// we only use the file store but you may plug in multiple. // we only use the file store but you may plug in multiple.
composer := tusd.NewStoreComposer() composer := tusd.NewStoreComposer()
store.UseIn(composer) store.UseIn(composer)
@ -245,7 +245,7 @@ The tusd binary, once executed, listens on the provided port for only non-encryp
### Can I run tusd behind a reverse proxy? ### Can I run tusd behind a reverse proxy?
Yes, it is absolutely possible to do so. Firstly, you should execute the tusd binary using the `-behind-proxy` flag indicating it to pay attention to special headers which are only relevent when used in conjunction with a proxy. Furthermore, there are addtional details which should be kept in mind, depending on the used software: Yes, it is absolutely possible to do so. Firstly, you should execute the tusd binary using the `-behind-proxy` flag indicating it to pay attention to special headers which are only relevant when used in conjunction with a proxy. Furthermore, there are additional details which should be kept in mind, depending on the used software:
- *Disable request buffering.* Nginx, for example, reads the entire incoming HTTP request, including its body, before sending it to the backend, by default. This behavior defeats the purpose of resumability where an upload is processed while it's being transfered. Therefore, such as feature should be disabled. - *Disable request buffering.* Nginx, for example, reads the entire incoming HTTP request, including its body, before sending it to the backend, by default. This behavior defeats the purpose of resumability where an upload is processed while it's being transfered. Therefore, such as feature should be disabled.

View File

@ -117,7 +117,7 @@ You can run tests in the root directory with `$ go test`. There is a benchmark-l
You can see `pester` in action with `$ cd sample; go run main.go`. You can see `pester` in action with `$ cd sample; go run main.go`.
For watching open file descriptors, you can run `watch "lsof -i -P | grep main"` if you started the app with `go run main.go`. For watching open file descriptors, you can run `watch "lsof -i -P | grep main"` if you started the app with `go run main.go`.
I did this for watching for FD leaks. My method was to alter `sample/main.go` to only run one case (`pester.Get with set backoff stategy, concurrency and retries increased`) I did this for watching for FD leaks. My method was to alter `sample/main.go` to only run one case (`pester.Get with set backoff strategy, concurrency and retries increased`)
and adding a sleep after the result came back. This let me verify if FDs were getting left open when they should have closed. If you know a better way, let me know! and adding a sleep after the result came back. This let me verify if FDs were getting left open when they should have closed. If you know a better way, let me know!
I was able to see that FDs are now closing when they should :) I was able to see that FDs are now closing when they should :)

View File

@ -19,7 +19,7 @@ obtain the same lock twice, this fork forbids this behavior.
install install
------- -------
Install [Go 1][5], either [from source][6] or [with a prepackaged binary][7]. Install [Go 1][5], either [from source][6] or [with a prepackaged binary][7].
For Windows suport, Go 1.4 or newer is required. For Windows support, Go 1.4 or newer is required.
Then run Then run