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

proxy

package

Go to main page

Versions in this module

v0

v0.18.5

Sep 23, 2026

Changes in this version

+ const ContainerName

+ const DNSContainerName

+ const DNSImage

+ const DNSPort

+ const DefaultDomain

+ const NetworkName

+ const StorefrontAssetsPort

+ const TraefikImage

+ var ErrNoSystemdResolved = errors.New("systemd-resolved is not available")

+ func ApplyRandomPorts(ctx context.Context, projectRoot, configPath string, cfg *shop.Config, ...) (*shop.Config, []docker.PortOverride, error)

+ func BaseDomain() string

+ func CACertPath() (string, error)

+ func CanonicalProjectRoot(projectRoot string) string

+ func CertHosts(domain string, extraHosts []string) []string

+ func ComposeProjectName(projectRoot string) string

+ func ConfigureResolver(ctx context.Context, baseDomain string) error — darwin/amd64, linux/amd64, windows/amd64

+ func ContainerCABundlePath(image string) (string, error)

+ func ContainerIsRunning(ctx context.Context) bool

+ func EnsureContainerCABundle(ctx context.Context, image, caPath string) (string, error)

+ func EnsureDNSContainerRunning(ctx context.Context, baseDomain string) error

+ func EnsureNetwork(ctx context.Context) error

+ func EnsureTraefikRunning(ctx context.Context, baseDomain string) error

+ func InstallTrust(ctx context.Context, caPath string) (string, error)

+ func IsProxyProject(cfg *shop.Config) bool

+ func IsProxyProjectForDomain(cfg *shop.Config, baseDomain string) bool

+ func LocalDomainHostname(name, baseDomain string) string

+ func ManualSetupInstructions(baseDomain, caPath string, includeTrust bool) string

+ func NewEnvironment(projectRoot string, cfg *shop.Config, proxyFallback bool) (*docker.Environment, error)

+ func NewProxiedEnvironment(projectRoot string, cfg *shop.Config, hostname string) (*docker.Environment, error)

+ func NoSystemdResolvedGuidance(baseDomain string) string

+ func PingHostname(baseDomain string) string

+ func ProjectHostname(projectRoot string, cfg *shop.Config, baseDomain string) (string, error)

+ func ProxyHostnames(hostname string, subdomains []string) []string

+ func ReconcileHostnames(ctx context.Context, hostnames []string) error

+ func RegisteredHostname(projectRoot string) (string, error)

+ func ResolverBlockedGuidance(baseDomain string) string — darwin/amd64, linux/amd64, windows/amd64

+ func ResolverManualInstructions(baseDomain string) string — darwin/amd64, linux/amd64, windows/amd64

+ func RestartTraefik(ctx context.Context) error

+ func SaveSettings(settings Settings) error

+ func ServerCertPath(dir string) string

+ func ServerKeyPath(dir string) string

+ func StateDir() (string, error)

+ func StopDNSContainer(ctx context.Context) error

+ func StopTraefik(ctx context.Context) error

+ func SupportsWildcardDNS(ctx context.Context) bool — darwin/amd64, linux/amd64, windows/amd64

+ func TrustBlockedGuidance(caPath string) string

+ func TrustInstructions(caPath string) string

+ func UnconfigureResolver(ctx context.Context, baseDomain string) error — darwin/amd64, linux/amd64, windows/amd64

+ func ValidateDomain(domain string) error

+ func WSLResolverGuidance() string

+ func WSLWindowsAccessGuidance(caPath string, hostnames []string) string

+ type CertInfo struct

+ CACreated bool

+ CAPath string

+ Changed bool

+ func EnsureCertificate(dir string, hosts []string) (CertInfo, error)

+ func PrepareInfra(ctx context.Context, p InfraParams, reg Registry) (CertInfo, error)

+ type CheckResult struct

+ Err error

+ Hint string

+ Name string

+ Pending bool

+ func Verify(ctx context.Context, baseDomain string) []CheckResult

+ type InfraParams struct

+ BaseDomain string

+ CanonicalRoot string

+ ConfigPath string

+ Hostname string

+ Image string

+ type Instance struct

+ Container string

+ Hostname string

+ func RunningInstances(ctx context.Context) ([]Instance, error)

+ type InstanceInfo struct

+ MemBytes int64

+ Name string

+ Running bool

+ URL string

+ Uptime time.Duration

+ func InstanceStats(ctx context.Context) (instances []InstanceInfo, combinedMem int64, err error)

+ type ProjectEntry struct

+ Hostname string

+ PreviousAppURL string

+ PreviousConfig *shop.ConfigURLState

+ ProjectRoot string

+ RegisteredAt time.Time

+ type Registry struct

+ Projects []ProjectEntry

+ func LoadRegistry() (Registry, error)

+ func (r *Registry) Remove(projectRoot string) bool

+ func (r *Registry) Upsert(entry ProjectEntry)

+ func (r Registry) Find(projectRoot string) (ProjectEntry, bool)

+ func (r Registry) FindByHostname(hostname, exceptProjectRoot string) (ProjectEntry, bool)

+ func (r Registry) Hostnames() []string

+ func (r Registry) Save() error

+ type ResolverStatus struct

+ Configured bool

+ Detail string

+ func CheckResolverConfigured(baseDomain string) ResolverStatus

+ type Settings struct

+ Domain string

+ func LoadSettings() (Settings, error)

+ func (s Settings) BaseDomain() string