docker

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 2, 2026 License: MIT Imports: 25 Imported by: 0

Documentation

Overview

Package docker materializes and drives the embedded reverse-proxy stack (Traefik + DNS server + network watcher) via `docker compose`, and hosts the network-attach watcher used inside the stack.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Down

func Down() error

Down stops and removes the stack without touching host configuration.

func Materialize

func Materialize(tld, certDir string) (string, error)

Materialize writes the embedded stack assets to disk, substituting the TLD, copies the TLS material from certDir into the stack, writes the compose environment file, and returns the stack directory.

func StackDir

func StackDir() (string, error)

StackDir returns the directory the embedded stack is materialized into.

func Up

func Up(tld, certDir string) error

Up materializes the stack and brings it up (building images as needed).

Types

type Route

type Route struct {
	Container string
	Host      string
	URL       string
	Note      string
}

Route is a routed container and a URL it is reachable at. When Note is set the container opted in but is not effectively served (e.g. an unresolved backend port the watcher skips); URL is then empty and Note explains why.

func Routes

func Routes(ctx context.Context) ([]Route, error)

Routes lists the effective routing state `proximo status` reports. It uses the same classifier (classify) the watcher uses to generate routers and certificates, so the two cannot disagree about which hosts are served. A proximo container whose backend port is ambiguous/unresolved (the watcher skips it) is flagged with a Note rather than listed as a working route. The classifyInfo diagnostics are ignored here so status stays quiet — no watcher warnings.

type Watcher

type Watcher struct {
	// contains filtered or unexported fields
}

Watcher keeps Traefik attached to the Docker networks of routed containers and issues a CA-signed certificate per container, written to Traefik's file-provider directory.

func NewWatcher

func NewWatcher() (*Watcher, error)

NewWatcher creates a Watcher from the Docker environment and loads the CA (for issuing per-host certificates) from the mounted paths.

func (*Watcher) Run

func (w *Watcher) Run(ctx context.Context) error

Run reconciles once, then reacts to Docker events with a periodic resync.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL