Help us shape the future of Go! Take the 2026 Go Developer Survey

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

v5

v5.7.0

Nov 2, 2026

Changes in this version

+ func CheckTarget(target container.Summary, serviceName, operation string) error

+ func IsContainer(ctr container.Summary) bool

+ func IsRelay(labels map[string]string) bool

+ func Networks(project *types.Project, service types.ServiceConfig) []string

+ type Backend interface

+ APIClient func() client.APIClient

+ Events func() api.EventProcessor

+ IsDesktopIntegrationActive func(ctx context.Context) (bool, error)

+ type InfoAnswer struct

+ Networks []NetworkInfo

+ type NetworkInfo struct

+ Gateway string

+ Name string

+ type Service struct

+ func New(backend Backend) *Service

+ func (s *Service) Ensure(ctx context.Context, project *types.Project, service types.ServiceConfig, ...) error

+ func (s *Service) Info(ctx context.Context, project *types.Project, service types.ServiceConfig) InfoAnswer

+ func (s *Service) LinkNetworks(ctx context.Context, projectName string) ([]network.Summary, error)

+ func (s *Service) Remove(ctx context.Context, projectName, serviceName string) error

+ func (s *Service) RemoveLinkNetwork(ctx context.Context, n network.Summary) error