quic-go's Introduction

A QUIC implementation in pure Go

quic-go is an implementation of the QUIC protocol (RFC 9000, RFC 9001, RFC 9002) in Go, including the Unreliable Datagram Extension (RFC 9221). It has support for HTTP/3 (RFC 9114), including QPACK (RFC 9204).

In addition the RFCs listed above, it currently implements the IETF QUIC draft-29. Support for draft-29 will eventually be dropped, as it is phased out of the ecosystem.

Guides

We currently support Go 1.18.x and Go 1.19.x.

Running tests:

go test ./...

QUIC without HTTP/3

Take a look at this echo example.

Usage

As a server

See the example server. Starting a QUIC server is very similar to the standard lib http in go:

http.Handle("/", http.FileServer(http.Dir(wwwDir)))
http3.ListenAndServeQUIC("localhost:4242", "/path/to/cert/chain.pem", "/path/to/privkey.pem", nil)

As a client

See the example client. Use a http3.RoundTripper as a Transport in a http.Client.

http.Client{
  Transport: &http3.RoundTripper{},
}

Projects using quic-go

Project	Description	Stars
algernon	Small self-contained pure-Go web server with Lua, Markdown, HTTP/2, QUIC, Redis and PostgreSQL support
caddy	Fast, multi-platform web server with automatic HTTPS
go-ipfs	IPFS implementation in go
syncthing	Open Source Continuous File Synchronization
traefik	The Cloud Native Application Proxy
v2ray-core	A platform for building proxies to bypass network restrictions
cloudflared	A tunneling daemon that proxies traffic from the Cloudflare network to your origins
OONI Probe	The Open Observatory of Network Interference (OONI) aims to empower decentralized efforts in documenting Internet censorship around the world.
YoMo	Streaming Serverless Framework for Geo-distributed System

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 help wanted. If you have any questions, please feel free to reach out by opening an issue or leaving a comment.

quic-go's People