caddy

Documentation

Index

• Variables
• func Enable(caddyfile string, player TemplateFunc)
• func GetConfigPaths() [][]string
• func GetInstance() *caddy.Instance
• func GetMaintenanceRoot() (string, error)
• func GetPathes() []string
• func RegisterPluginTemplate(fn TemplateFunc, watchConfigPath []string, pathes ...string) error
• func Restart() error
• func ServiceReady(name string) bool
• func Start() error
• func StartWithFastRestart() (chan bool, error)
• func Stop() error
• type Caddy
  • func Get() *Caddy
  • func (c *Caddy) GetTemplate() *template.Template
  • func (c *Caddy) Play() (*bytes.Buffer, error)
• type SiteConf
  • func SiteConfFromProxyConfig(pc *install.ProxyConfig) (SiteConf, error)
  • func SitesToCaddyConfigs(sites []*install.ProxyConfig) (caddySites []SiteConf, er error)
  • func (s SiteConf) Redirects() map[string]string
• type TemplateFunc
  • func GetTemplates() []TemplateFunc

Variables

var (
	DefaultCaUrl        = "https://acme-v02.api.letsencrypt.org/directory"
	DefaultCaStagingUrl = "https://acme-staging-v02.api.letsencrypt.org/directory"
)

var (
	FuncMap = template.FuncMap{
		"urls":           internalURLFromServices,
		"serviceAddress": addressFromService,
	}
)

Functions

func Enable

func Enable(caddyfile string, player TemplateFunc)

Enable the caddy builder

func GetConfigPaths

func GetConfigPaths() [][]string

func GetInstance

func GetInstance() *caddy.Instance

func GetMaintenanceRoot

func GetMaintenanceRoot() (string, error)

func GetPathes

func GetPathes() []string

func RegisterPluginTemplate

func RegisterPluginTemplate(fn TemplateFunc, watchConfigPath []string, pathes ...string) error

RegisterPluginTemplate adds a TemplateFunc to be called for each plugin

func Restart

func Restart() error

func ServiceReady

func ServiceReady(name string) bool

func Start

func Start() error

func StartWithFastRestart

func StartWithFastRestart() (chan bool, error)

func Stop

func Stop() error

Types

type Caddy

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

Caddy contains the templates and functions for building a dynamic caddyfile

func Get

func Get() *Caddy

Get returns the currently enabled caddy builder

func (*Caddy) GetTemplate

func (c *Caddy) GetTemplate() *template.Template

func (*Caddy) Play

func (c *Caddy) Play() (*bytes.Buffer, error)

type SiteConf

type SiteConf struct {
	*install.ProxyConfig
	// Parsed values from proto oneOf
	TLS     string
	TLSCert string
	TLSKey  string
	// Parsed External host if any
	ExternalHost string
	// Custom Root for this site
	WebRoot string
}

func SiteConfFromProxyConfig

func SiteConfFromProxyConfig(pc *install.ProxyConfig) (SiteConf, error)

func SitesToCaddyConfigs

func SitesToCaddyConfigs(sites []*install.ProxyConfig) (caddySites []SiteConf, er error)

func (SiteConf) Redirects

func (s SiteConf) Redirects() map[string]string

type TemplateFunc

type TemplateFunc func(site ...SiteConf) (*bytes.Buffer, error)

TemplateFunc is a function providing a stringer

func GetTemplates

func GetTemplates() []TemplateFunc