caddy

package module

Go to main page

Versions in this module

v0

v0.12.0

Jul 28, 2022

v0.11.5

Mar 4, 2019

Changes in this version

+ const InstanceRestartEvent

+ var OnProcessExit []func()

+ func ListPlugins() map[string][]string

type Controller

+ func (c *Controller) Get(key interface{}) interface{}

+ func (c *Controller) OnRestartFailed(fn func() error)

+ func (c *Controller) Set(key, val interface{})

type GracefulServer

+ WrapListener func(net.Listener) net.Listener

type Instance

+ OnFinalShutdown []func() error

+ OnFirstStartup []func() error

+ OnRestart []func() error

+ OnRestartFailed []func() error

+ OnShutdown []func() error

+ OnStartup []func() error

+ Storage map[interface{}]interface{}

+ StorageMu sync.RWMutex

+ func Instances() []*Instance

v0.10.10

Oct 9, 2017

Changes in this version

type EventName

+ const CertRenewEvent

+ const InstanceStartupEvent

v0.10.9

Sep 12, 2017

v0.10.8

Sep 8, 2017

v0.10.7

Aug 25, 2017

v0.10.5

Jul 27, 2017

v0.10.0

Apr 20, 2017

Changes in this version

+ func EmitEvent(event EventName)

+ func IsInternal(addr string) bool

+ func RegisterEventHook(name string, hook EventHook)

+ func ValidateAndExecuteDirectives(cdyfile Input, inst *Instance, justValidate bool) error

+ type EventHook func(eventType EventName) error

+ type EventName string

+ const ShutdownEvent

+ const StartupEvent

v0.9.3

Sep 28, 2016

v0.9.2

Sep 20, 2016

Changes in this version

+ var AppName string

+ var AppVersion string

+ var DefaultConfigFile = "Caddyfile"

+ var GracefulTimeout time.Duration

+ var PidFile string

+ var Quiet bool

+ func AssetsPath() string

+ func DescribePlugins() string

+ func HasListenerWithAddress(addr string) bool

+ func IsLoopback(addr string) bool

+ func IsUpgrade() bool

+ func RegisterCaddyfileLoader(name string, loader Loader)

+ func RegisterParsingCallback(serverType, afterDir string, callback ParsingCallback)

+ func RegisterPlugin(name string, plugin Plugin)

+ func RegisterServerType(typeName string, srv ServerType)

+ func SetDefaultCaddyfileLoader(name string, loader Loader)

+ func SplitCommandAndArgs(command string) (cmd string, args []string, err error)

+ func Started() bool

+ func Upgrade() error

+ func ValidDirectives(serverType string) []string

+ type AfterStartup interface

+ OnStartupComplete func()

+ type CaddyfileInput struct

+ Contents []byte

+ Filepath string

+ ServerTypeName string

+ func (c CaddyfileInput) Body() []byte

+ func (c CaddyfileInput) Path() string

+ func (c CaddyfileInput) ServerType() string

type Context

+ InspectServerBlocks func(string, []caddyfile.ServerBlock) ([]caddyfile.ServerBlock, error)

+ MakeServers func() ([]Server, error)

+ type Controller struct

+ Key string

+ OncePerServerBlock func(f func() error) error

+ ServerBlockIndex int

+ ServerBlockKeyIndex int

+ ServerBlockKeys []string

+ ServerBlockStorage interface{}

+ func NewTestController(serverType, input string) *Controller

+ func (c *Controller) Context() Context

+ func (c *Controller) OnFinalShutdown(fn func() error)

+ func (c *Controller) OnFirstStartup(fn func() error)

+ func (c *Controller) OnRestart(fn func() error)

+ func (c *Controller) OnShutdown(fn func() error)

+ func (c *Controller) OnStartup(fn func() error)

+ func (c *Controller) ServerType() string

+ type GracefulServer interface

+ Address func() string

+ type Input interface

+ Body func() []byte

+ Path func() string

+ ServerType func() string

+ func CaddyfileFromPipe(f *os.File, serverType string) (Input, error)

+ func DefaultInput(serverType string) Input

+ func LoadCaddyfile(serverType string) (Input, error)

+ type Instance struct

+ func Start(cdyfile Input) (*Instance, error)

+ func (i *Instance) Caddyfile() Input

+ func (i *Instance) Restart(newCaddyfile Input) (*Instance, error)

+ func (i *Instance) SaveServer(s Server, ln net.Listener)

+ func (i *Instance) Servers() []ServerListener

+ func (i *Instance) ShutdownCallbacks() []error

+ func (i *Instance) Stop() error

+ func (i *Instance) Wait()

+ type Listener interface

+ File func() (*os.File, error)

+ type Loader interface

+ Load func(serverType string) (Input, error)

+ type LoaderFunc func(serverType string) (Input, error)

+ func (lf LoaderFunc) Load(serverType string) (Input, error)

+ type PacketConn interface

+ File func() (*os.File, error)

+ type ParsingCallback func(Context) error

+ type Plugin struct

+ Action SetupFunc

+ ServerType string

+ type Server interface

+ type ServerListener struct

+ func (s ServerListener) Addr() net.Addr

+ func (s ServerListener) LocalAddr() net.Addr

+ type ServerType struct

+ DefaultInput func() Input

+ Directives func() []string

+ NewContext func() Context

+ type SetupFunc func(c *Controller) error

+ func DirectiveAction(serverType, dir string) (SetupFunc, error)

+ type Stopper interface

+ Stop func() error

+ type TCPServer interface

+ Listen func() (net.Listener, error)

+ Serve func(net.Listener) error

+ type UDPServer interface

+ ListenPacket func() (net.PacketConn, error)

+ ServePacket func(net.PacketConn) error

v0.8.3

Apr 26, 2016

v0.8.1

Jan 12, 2016

v0.8.0

Dec 4, 2015

v0.7.5

Aug 5, 2015

v0.7.3

Jul 15, 2015

v0.7.2

Jul 1, 2015

v0.7.0

May 25, 2015

v0.6.0

May 6, 2015

v0.0.2

Jul 28, 2022

v0.0.1

Jul 28, 2022

Changes in this version

+ const ExitCodeFailedQuit

+ const ExitCodeFailedStartup

+ const ExitCodeForceQuit

+ const ExitCodeSuccess

+ const ImportPath

+ var ConfigAutosavePath = filepath.Join(AppConfigDir(), "autosave.json")

+ var DefaultAdminListen = "localhost:2019"

+ var DefaultRemoteAdminListen = ":2021"

+ var DefaultStorage = &certmagic.FileStorage

+ func AppConfigDir() string

+ func AppDataDir() string

+ func GetModuleID(instance interface{}) string

+ func GetModuleName(instance interface{}) string

+ func GoModule() *debug.Module

+ func HomeDir() string

+ func InstanceID() (uuid.UUID, error)

+ func JoinNetworkAddress(network, host, port string) string

+ func Listen(network, addr string) (net.Listener, error)

+ func ListenPacket(network, addr string) (net.PacketConn, error)

+ func Load(cfgJSON []byte, forceReload bool) error

+ func Log() *zap.Logger

+ func Modules() []string

+ func PIDFile(filename string) error

+ func ParseDuration(s string) (time.Duration, error)

+ func ParseStructTag(tag string) (map[string]string, error)

+ func RegisterModule(instance Module)

+ func RemoveMetaFields(rawJSON []byte) []byte

+ func Run(cfg *Config) error

+ func SplitNetworkAddress(a string) (network, host, port string, err error)

+ func Stop() error

+ func TrapSignals()

+ func Validate(cfg *Config) error

+ type APIError struct

+ Err error

+ HTTPStatus int

+ Message string

+ func (e APIError) Error() string

+ type AdminAccess struct

+ Permissions []AdminPermissions

+ PublicKeys []string

+ type AdminConfig struct

+ Config *ConfigSettings

+ Disabled bool

+ EnforceOrigin bool

+ Identity *IdentityConfig

+ Listen string

+ Origins []string

+ Remote *RemoteAdmin

+ type AdminHandler interface

+ ServeHTTP func(http.ResponseWriter, *http.Request) error

+ type AdminHandlerFunc func(http.ResponseWriter, *http.Request) error

+ func (f AdminHandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request) error

+ type AdminPermissions struct

+ Methods []string

+ Paths []string

+ type AdminRoute struct

+ Handler AdminHandler

+ Pattern string

+ type AdminRouter interface

+ Routes func() []AdminRoute

+ type App interface

+ Start func() error

+ Stop func() error

+ type CleanerUpper interface

+ Cleanup func() error

+ type Config struct

+ Admin *AdminConfig

+ AppsRaw ModuleMap

+ Logging *Logging

+ StorageRaw json.RawMessage

+ type ConfigLoader interface

+ LoadConfig func(Context) ([]byte, error)

+ type ConfigSettings struct

+ LoadDelay Duration

+ LoadRaw json.RawMessage

+ Persist *bool

+ type Constructor func() (Destructor, error)

+ type Context struct

+ func NewContext(ctx Context) (Context, context.CancelFunc)

+ func (ctx *Context) OnCancel(f func())

+ func (ctx Context) App(name string) (interface{}, error)

+ func (ctx Context) AppIsConfigured(name string) bool

+ func (ctx Context) IdentityCredentials(logger *zap.Logger) ([]tls.Certificate, error)

+ func (ctx Context) LoadModule(structPointer interface{}, fieldName string) (interface{}, error)

+ func (ctx Context) LoadModuleByID(id string, rawMsg json.RawMessage) (interface{}, error)

+ func (ctx Context) Logger(mod Module) *zap.Logger

+ func (ctx Context) Storage() certmagic.Storage

+ type CtxKey string

+ const ReplacerCtxKey

+ type CustomLog struct

+ EncoderRaw json.RawMessage

+ Exclude []string

+ Include []string

+ Level string

+ Sampling *LogSampling

+ WriterRaw json.RawMessage

+ type Destructor interface

+ Destruct func() error

+ type DiscardWriter struct

+ func (DiscardWriter) CaddyModule() ModuleInfo

+ func (DiscardWriter) OpenWriter() (io.WriteCloser, error)

+ func (DiscardWriter) String() string

+ func (DiscardWriter) WriterKey() string

+ type Duration time.Duration

+ func (d *Duration) UnmarshalJSON(b []byte) error

+ type IdentityConfig struct

+ Identifiers []string

+ IssuersRaw []json.RawMessage

+ type ListenerWrapper interface

+ WrapListener func(net.Listener) net.Listener

+ type LogSampling struct

+ First int

+ Interval time.Duration

+ Thereafter int

+ type Logging struct

+ Logs map[string]*CustomLog

+ Sink *StandardLibLog

+ func (logging *Logging) Logger(mod Module) *zap.Logger

+ type Module interface

+ CaddyModule func() ModuleInfo

+ type ModuleID string

+ func (id ModuleID) Name() string

+ func (id ModuleID) Namespace() string

+ type ModuleInfo struct

+ ID ModuleID

+ New func() Module

+ func GetModule(name string) (ModuleInfo, error)

+ func GetModules(scope string) []ModuleInfo

+ func (mi ModuleInfo) String() string

+ type ModuleMap map[string]json.RawMessage

+ type NetworkAddress struct

+ EndPort uint

+ Host string

+ Network string

+ StartPort uint

+ func ParseNetworkAddress(addr string) (NetworkAddress, error)

+ func (na NetworkAddress) IsUnixNetwork() bool

+ func (na NetworkAddress) JoinHostPort(offset uint) string

+ func (na NetworkAddress) PortRangeSize() uint

+ func (na NetworkAddress) String() string

+ type Provisioner interface

+ Provision func(Context) error

+ type RemoteAdmin struct

+ AccessControl []*AdminAccess

+ Listen string

+ type ReplacementFunc func(variable string, val interface{}) (interface{}, error)

+ type Replacer struct

+ func NewEmptyReplacer() *Replacer

+ func NewReplacer() *Replacer

+ func (r *Replacer) Delete(variable string)

+ func (r *Replacer) Get(variable string) (interface{}, bool)

+ func (r *Replacer) GetString(variable string) (string, bool)

+ func (r *Replacer) Map(mapFunc ReplacerFunc)

+ func (r *Replacer) ReplaceAll(input, empty string) string

+ func (r *Replacer) ReplaceFunc(input string, f ReplacementFunc) (string, error)

+ func (r *Replacer) ReplaceKnown(input, empty string) string

+ func (r *Replacer) ReplaceOrErr(input string, errOnEmpty, errOnUnknown bool) (string, error)

+ func (r *Replacer) Set(variable string, value interface{})

+ type ReplacerFunc func(key string) (interface{}, bool)

+ type StandardLibLog struct

+ WriterRaw json.RawMessage

+ type StderrWriter struct

+ func (StderrWriter) CaddyModule() ModuleInfo

+ func (StderrWriter) OpenWriter() (io.WriteCloser, error)

+ func (StderrWriter) String() string

+ func (StderrWriter) WriterKey() string

+ type StdoutWriter struct

+ func (StdoutWriter) CaddyModule() ModuleInfo

+ func (StdoutWriter) OpenWriter() (io.WriteCloser, error)

+ func (StdoutWriter) String() string

+ func (StdoutWriter) WriterKey() string

+ type StorageConverter interface

+ CertMagicStorage func() (certmagic.Storage, error)

+ type UsagePool struct

+ func NewUsagePool() *UsagePool

+ func (up *UsagePool) Delete(key interface{}) (deleted bool, err error)

+ func (up *UsagePool) LoadOrNew(key interface{}, construct Constructor) (value interface{}, loaded bool, err error)

+ func (up *UsagePool) LoadOrStore(key, val interface{}) (value interface{}, loaded bool)

+ func (up *UsagePool) Range(f func(key, value interface{}) bool)

+ type Validator interface

+ Validate func() error

+ type WriterOpener interface

+ OpenWriter func() (io.WriteCloser, error)

+ WriterKey func() string

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