cadet

package
v0.0.1 Latest Latest
Warning

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

Go to latest
Published: Oct 19, 2026 License: BSD-3-Clause Imports: 25 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var WildcardCIDR *net.IPNet

Functions

This section is empty.

Types

type AutoReverseProxyConfig

type AutoReverseProxyConfig struct {
	HTTPPort   int               `json:"http_port"`
	HTTPSPort  int               `json:"https_port"`
	TLSIssuers []json.RawMessage `json:"tls_issuers" caddy:"namespace=tls.issuance inline_key=module"`
	Protocols  []string          `json:"protocols"`
}

func DefaultAutoReverseProxyConfig

func DefaultAutoReverseProxyConfig() *AutoReverseProxyConfig

type Dashboard

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

Dashboard is an HTTP handler serving the cadet web UI. It reads services and global config from the cadet app, so that app must be configured.

func (Dashboard) CaddyModule

func (Dashboard) CaddyModule() caddy.ModuleInfo

func (*Dashboard) Provision

func (d *Dashboard) Provision(ctx caddy.Context) error

func (*Dashboard) ServeHTTP

type DashboardConfig

type DashboardConfig struct {
	Enabled bool       `json:"enabled"`
	Name    string     `json:"name"`
	Zones   []string   `json:"zones"`
	ACL     acl.Policy `json:"acl"`
}

DashboardConfig controls the web UI. When enabled it is published as a service like any other, with a hostname, TLS and ACLs, but served by the cadet_dashboard handler instead of a reverse proxy.

func DefaultDashboardConfig

func DefaultDashboardConfig() *DashboardConfig

func (*DashboardConfig) Service

func (d *DashboardConfig) Service() *service.Config

Service returns the dashboard as a service config. An empty ACL falls back to the global default policy, as it does for real services.

type Plugin

type Plugin struct {
	Consul           *config.ConsulConfig    `json:"consul"`
	AutoReverseProxy *AutoReverseProxyConfig `json:"auto_reverse_proxy"`
	Dashboard        *DashboardConfig        `json:"dashboard,omitempty"`
	// contains filtered or unexported fields
}

func NewPlugin

func NewPlugin() *Plugin

func (Plugin) CaddyModule

func (plug Plugin) CaddyModule() caddy.ModuleInfo

func (*Plugin) Cleanup

func (plug *Plugin) Cleanup() error

func (*Plugin) Provision

func (plug *Plugin) Provision(ctx caddy.Context) error

func (*Plugin) Start

func (plug *Plugin) Start() error

func (*Plugin) Stop

func (plug *Plugin) Stop() error

func (*Plugin) Validate

func (plug *Plugin) Validate() error

type ProxyConfig

type ProxyConfig struct {
	Servers map[string]ProxyServer
}

type ProxyServer

type ProxyServer struct {
	Port     int            `json:"port"`
	Services []ProxyService `json:"servers"`
}

type ProxyService

type ProxyService struct {
	Name      string     `json:"name"`
	Hostnames []string   `json:"hostnames"`
	Upstreams []string   `json:"upstreams"`
	ACL       acl.Policy `json:"acl"`
}

Jump to

Keyboard shortcuts

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