config

type EnabledEndpointsMap map[string]struct{}

type Options struct {
	// Logger is the zerolog logger for the HTTP API server and middleware.
	// Required when any HTTP API endpoint is enabled.
	// SetupAndStartAPI returns ErrMissingLogger if it is nil.
	// The composition root should pass a child with notify=no when high-volume
	// request/auth logs must not trigger notification hooks.
	// New also attaches notify=no on request and rate-limit log paths.
	Logger *zerolog.Logger
	// Host is the HTTP bind host (empty means all interfaces).
	Host string
	// Port is the HTTP bind port.
	Port string
	// Token authenticates HTTP API requests.
	Token string
	// EventsToken authenticates the events SSE endpoint.
	EventsToken string
	// RateLimit is the maximum authentication requests per minute per IP.
	RateLimit int
	// EnableUpdateAPI enables the /v1/update endpoint.
	EnableUpdateAPI bool
	// EnableMetricsAPI enables the metrics endpoint.
	EnableMetricsAPI bool
	// EnableContainersAPI enables the containers listing endpoint.
	EnableContainersAPI bool
	// EnableCheckAPI enables the /v1/check endpoint.
	EnableCheckAPI bool
	// EnableSwaggerAPI enables the Swagger UI endpoint.
	EnableSwaggerAPI bool
	// EnableHealthAPI enables health probe endpoints.
	EnableHealthAPI bool
	// EnableHistoryAPI enables the history endpoint.
	EnableHistoryAPI bool
	// EnableImagesAPI enables the images endpoint.
	EnableImagesAPI bool
	// EnableConfigAPI enables the config inspection endpoint.
	EnableConfigAPI bool
	// EnableEventsAPI enables the events SSE endpoint.
	EnableEventsAPI bool
	// UnblockHTTPAPI keeps scheduled polls running when the HTTP API is enabled.
	UnblockHTTPAPI bool
	// NoStartupMessage suppresses startup logs and notifications.
	NoStartupMessage bool
	// TLSCertPath is the path to the TLS certificate file.
	TLSCertPath string
	// TLSKeyPath is the path to the TLS key file.
	TLSKeyPath string
	// CORSAllowedOrigins lists allowed CORS origins.
	CORSAllowedOrigins []string
	// TrustedProxies lists trusted proxy IPs or CIDRs.
	TrustedProxies []string
	// ProxyHeader is the header used for the real client IP behind a reverse proxy.
	ProxyHeader string
	// Filter is the process-wide container filter predicate.
	Filter types.Filter
	// FilterDesc is a human-readable description of the filter for startup messaging.
	FilterDesc string
	// UpdateLock serializes concurrent update sessions.
	UpdateLock chan bool
	// BaseParams is the complete update policy snapshot from config.UpdateParams.
	BaseParams types.UpdateParams
	// IncludeStopped is exposed on the config API (client list option).
	IncludeStopped bool
	// IncludeRestarting is exposed on the config API (client list option).
	IncludeRestarting bool
	// LabelEnable is exposed on the config API (filter option).
	LabelEnable bool
	// Client is the Docker client used by API handlers.
	Client container.Client
	// Notifier sends update and check status messages.
	Notifier types.Notifier
	// NotificationSplitByContainer sends one notification per updated container when true.
	NotificationSplitByContainer bool
	// Scope limits operations to containers matching this Watchtower scope.
	Scope string
	// Version is the Watchtower version string used in startup messaging.
	Version string
	// Startup holds resolved values for blocking-mode startup messaging.
	Startup logging.StartupParams
	// RunUpdatesWithNotifications runs the scan-and-update pipeline for HTTP update requests.
	RunUpdatesWithNotifications func(context.Context, types.Filter, types.UpdateParams) *mt.Metric
	// FilterByImage builds an image-scoped filter for update and check requests.
	FilterByImage func([]string, types.Filter) types.Filter
	// DefaultMetrics returns the process metrics store.
	DefaultMetrics func() *mt.Metrics
	// WriteStartupMessage writes the blocking-mode startup message when the update API starts.
	WriteStartupMessage func(logging.StartupParams)
	// EventBroadcaster publishes action events to SSE subscribers.
	EventBroadcaster *events.Broadcaster
	// OnUnexpectedServerStop is invoked when the HTTP server exits with an
	// unexpected error while running in non-blocking mode. Callers typically
	// cancel the process context so scheduling shuts down with the API.
	OnUnexpectedServerStop func(error)
	// CheckTimeout is the maximum duration for the /v1/check API endpoint.
	// If zero, DefaultCheckTimeout is used.
	CheckTimeout time.Duration
	// UpdateTimeout is the maximum duration for the /v1/update API endpoint.
	// If zero, DefaultUpdateTimeout is used.
	UpdateTimeout time.Duration
}