Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

relay

package

Go to main page

Versions in this module

v0

v0.15.3

May 7, 2026

v0.15.2

May 6, 2026

v0.15.1

May 6, 2026

v0.15.0

May 6, 2026

Changes in this version

+ type HostPort struct

+ Host string

+ Port uint16

type Ingress

+ AdvertiseAddresses []HostPort

+ ListenAddress *net.UDPAddr

type IngressBuilder

+ func (b *IngressBuilder) WithAdvertiseAddress(hp HostPort) *IngressBuilder

+ func (b *IngressBuilder) WithAdvertiseAddressFrom(addr string) *IngressBuilder

+ func (b *IngressBuilder) WithListenAddress(addr *net.UDPAddr) *IngressBuilder

+ func (b *IngressBuilder) WithListenAddressFrom(addrStr string) *IngressBuilder

v0.14.1

Feb 22, 2026

v0.14.0

Feb 18, 2026

Changes in this version

+ type ClientAuthenticator interface

+ Authenticate func(req *pbclientrelay.AuthenticateReq, cert *x509.Certificate) (*clientAuth, error)

type Stores

+ RemoveDeprecated func() error

v0.13.2

Jan 14, 2026

v0.13.1

Jan 13, 2026

Changes in this version

type Status

+ BuildVersion string

v0.13.0

Jan 12, 2026

Changes in this version

+ type EndpointPeerStatus struct

+ Key model.Key

+ Metadata string

v0.12.0

Jan 11, 2026

Changes in this version

+ type ClientKey struct

+ Endpoint model.Endpoint

+ Key model.Key

+ Role model.Role

+ type ClientValue struct

+ Cert *x509.Certificate

+ func (v *ClientValue) UnmarshalJSON(b []byte) error

+ func (v ClientValue) MarshalJSON() ([]byte, error)

+ type Config struct

+ ControlAddr *net.UDPAddr

+ ControlCAs *x509.CertPool

+ ControlHost string

+ ControlToken string

+ HandshakeIdleTimeout time.Duration

+ Ingress []Ingress

+ Logger *slog.Logger

+ Metadata string

+ Stores Stores

+ type ConfigKey string

+ type ConfigValue struct

+ Bytes []byte

+ Int64 int64

+ String string

+ type EndpointStatus struct

+ Destinations []string

+ Endpoint model.Endpoint

+ Sources []string

+ type Ingress struct

+ Addr *net.UDPAddr

+ Hostports []model.HostPort

+ Restr restr.IP

+ type IngressBuilder struct

+ func NewIngressBuilder() *IngressBuilder

+ func (b *IngressBuilder) Error() error

+ func (b *IngressBuilder) Ingress() (Ingress, error)

+ func (b *IngressBuilder) WithAddr(addr *net.UDPAddr) *IngressBuilder

+ func (b *IngressBuilder) WithAddrFrom(addrStr string) *IngressBuilder

+ func (b *IngressBuilder) WithHostport(hp model.HostPort) *IngressBuilder

+ func (b *IngressBuilder) WithHostportFrom(hostport string) *IngressBuilder

+ func (b *IngressBuilder) WithHostports(hps []model.HostPort) *IngressBuilder

+ func (b *IngressBuilder) WithRestr(iprestr restr.IP) *IngressBuilder

+ func (b *IngressBuilder) WithRestrFrom(allows []string, denies []string) *IngressBuilder

+ type Server struct

+ func NewServer(cfg Config) (*Server, error)

+ func (s *Server) Run(ctx context.Context) error

+ func (s *Server) Status(ctx context.Context) (Status, error)

+ type ServerKey struct

+ Endpoint model.Endpoint

+ type ServerValue struct

+ Cert *certc.Cert

+ Clients map[serverClientKey]ClientValue

+ Name string

+ func (v *ServerValue) UnmarshalJSON(b []byte) error

+ func (v ServerValue) MarshalJSON() ([]byte, error)

+ type Status struct

+ Endpoints map[string]EndpointStatus

+ Hostports []string

+ ServerAddr string

+ ServerID string

+ Status statusc.Status

+ type Stores interface

+ Clients func() (logc.KV[ClientKey, ClientValue], error)

+ Config func() (logc.KV[ConfigKey, ConfigValue], error)

+ Servers func() (logc.KV[ServerKey, ServerValue], error)

+ func NewFileStores(dir string) Stores

+ type TransportsFn func(ctx context.Context) ([]*quic.Transport, error)