73 lines
3 KiB
Markdown
73 lines
3 KiB
Markdown
|
# A QUIC implementation in pure Go
|
||
|
|
|
||
|
|
<img src="docs/quic.png" width=303 height=124>
|
||
|
|
|
||
|
|
[](https://godoc.org/github.com/lucas-clemente/quic-go)
|
||
|
|
[](https://travis-ci.org/lucas-clemente/quic-go)
|
||
|
|
[](https://ci.appveyor.com/project/lucas-clemente/quic-go/branch/master)
|
||
|
|
[](https://codecov.io/gh/lucas-clemente/quic-go/)
|
||
|
|
|
||
|
|
quic-go is an implementation of the [QUIC](https://en.wikipedia.org/wiki/QUIC) protocol in Go.
|
||
|
|
|
||
|
|
## Roadmap
|
||
|
|
|
||
|
|
quic-go is compatible with the current version(s) of Google Chrome and QUIC as deployed on Google's servers. We're actively tracking the development of the Chrome code to ensure compatibility as the protocol evolves. In that process, we're dropping support for old QUIC versions.
|
||
|
|
As Google's QUIC versions are expected to converge towards the [IETF QUIC draft](https://github.com/quicwg/base-drafts), quic-go will eventually implement that draft.
|
||
|
|
|
||
|
|
## Guides
|
||
|
|
|
||
|
|
We currently support Go 1.8+.
|
||
|
|
|
||
|
|
Installing and updating dependencies:
|
||
|
|
|
||
|
|
go get -t -u ./...
|
||
|
|
|
||
|
|
Running tests:
|
||
|
|
|
||
|
|
go test ./...
|
||
|
|
|
||
|
|
### Running the example server
|
||
|
|
|
||
|
|
go run example/main.go -www /var/www/
|
||
|
|
|
||
|
|
Using the `quic_client` from chromium:
|
||
|
|
|
||
|
|
quic_client --host=127.0.0.1 --port=6121 --v=1 https://quic.clemente.io
|
||
|
|
|
||
|
|
Using Chrome:
|
||
|
|
|
||
|
|
/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --user-data-dir=/tmp/chrome --no-proxy-server --enable-quic --origin-to-force-quic-on=quic.clemente.io:443 --host-resolver-rules='MAP quic.clemente.io:443 127.0.0.1:6121' https://quic.clemente.io
|
||
|
|
|
||
|
|
### QUIC without HTTP/2
|
||
|
|
|
||
|
|
Take a look at [this echo example](example/echo/echo.go).
|
||
|
|
|
||
|
|
### Using the example client
|
||
|
|
|
||
|
|
go run example/client/main.go https://clemente.io
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
### As a server
|
||
|
|
|
||
|
|
See the [example server](example/main.go) or try out [Caddy](https://github.com/mholt/caddy) (from version 0.9, [instructions here](https://github.com/mholt/caddy/wiki/QUIC)). Starting a QUIC server is very similar to the standard lib http in go:
|
||
|
|
|
||
|
|
```go
|
||
|
|
http.Handle("/", http.FileServer(http.Dir(wwwDir)))
|
||
|
|
h2quic.ListenAndServeQUIC("localhost:4242", "/path/to/cert/chain.pem", "/path/to/privkey.pem", nil)
|
||
|
|
```
|
||
|
|
|
||
|
|
### As a client
|
||
|
|
|
||
|
|
See the [example client](example/client/main.go). Use a `h2quic.RoundTripper` as a `Transport` in a `http.Client`.
|
||
|
|
|
||
|
|
```go
|
||
|
|
http.Client{
|
||
|
|
Transport: &h2quic.RoundTripper{},
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
We are always happy to welcome new contributors! We have a number of self-contained issues that are suitable for first-time contributors, they are tagged with [want-help](https://github.com/lucas-clemente/quic-go/issues?q=is%3Aopen+is%3Aissue+label%3Awant-help). If you have any questions, please feel free to reach out by opening an issue or leaving a comment.
|