caddy

May 28, 2024

Changes in this version

+ var ErrNotConfigured = fmt.Errorf("module not configured")

+ func IsWriterStandardStream(wo WriterOpener) bool

+ func OnExit(f func(context.Context))

type BaseLog

+ WithCaller bool

+ WithCallerSkip int

+ WithStacktrace string

+ type ConfiguresFormatterDefault interface

+ ConfigureDefaultFormat func(WriterOpener) error

type Context

+ func (ctx *Context) Filesystems() FileSystems

+ func (ctx *Context) OnExit(f func(context.Context))

+ func (ctx *Context) WithValue(key, value any) Context

+ func (ctx Context) Slogger() *slog.Logger

+ type FileSystems interface

+ Default func() fs.FS

+ Get func(k string) (v fs.FS, ok bool)

+ Register func(k string, v fs.FS)

+ Unregister func(k string)

type Replacer

+ func (r *Replacer) WithoutFile() *Replacer

Dec 7, 2023

Changes in this version

type NetworkAddress

+ func (na NetworkAddress) ListenQUIC(ctx context.Context, portOffset uint, config net.ListenConfig, ...) (http3.QUICEarlyListener, error)

Aug 2, 2023

Changes in this version

+ func StrictUnmarshalJSON(data []byte, v any) error

+ type BaseLog struct

+ EncoderRaw json.RawMessage

+ Level string

+ Sampling *LogSampling

+ WriterRaw json.RawMessage

type Context

+ func (ctx Context) AppIfConfigured(name string) any

type NetworkAddress

+ func ParseNetworkAddressWithDefaults(addr, defaultNetwork string, defaultPort uint) (NetworkAddress, error)

+ type SinkLog struct

Feb 8, 2023

Changes in this version

+ func IsUnixNetwork(netw string) bool

Oct 13, 2022

Changes in this version

+ const DefaultLoggerName

+ var CustomVersion string

type NetworkAddress

+ func (na NetworkAddress) At(portOffset uint) NetworkAddress

+ func (na NetworkAddress) Listen(ctx context.Context, portOffset uint, config net.ListenConfig) (any, error)

+ func (na NetworkAddress) ListenAll(ctx context.Context, config net.ListenConfig) ([]any, error)

Sep 20, 2022

Changes in this version

+ func Exiting() bool

+ func ListenTimeout(network, addr string, keepAlivePeriod time.Duration) (net.Listener, error) — darwin/amd64, js/wasm, windows/amd64

+ func ListenTimeout(network, addr string, keepalivePeriod time.Duration) (net.Listener, error) — linux/amd64

+ func ListenerUsage(network, addr string) int

+ func RegisterNetwork(network string, getListener ListenerFunc)

+ func ToString(val any) string

+ func Version() (simple, full string)

type Context

+ func ActiveContext() Context

+ func (ctx Context) Module() Module

+ func (ctx Context) Modules() []Module

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

type NetworkAddress

+ func (na NetworkAddress) Expand() []NetworkAddress

type UsagePool

+ func (up *UsagePool) References(key any) (int, bool)

Apr 25, 2022

Changes in this version

+ func ListenQUIC(addr string, tlsConf *tls.Config) (quic.EarlyListener, error)

type ConfigSettings

+ LoadDelay Duration

type Context

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

Nov 8, 2021 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Sep 3, 2021 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Aug 30, 2021 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Changes in this version

type ConfigSettings

+ LoadInterval Duration

Jun 17, 2021 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Jun 12, 2021 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

May 19, 2021 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

May 10, 2021 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Changes in this version

+ var DefaultRemoteAdminListen = ":2021"

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

type APIError

+ HTTPStatus int

+ type AdminAccess struct

+ Permissions []AdminPermissions

+ PublicKeys []string

type AdminConfig

+ Identity *IdentityConfig

+ Remote *RemoteAdmin

+ type AdminPermissions struct

+ Methods []string

+ Paths []string

+ type ConfigLoader interface

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

type ConfigSettings

+ LoadRaw json.RawMessage

type Context

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

+ type IdentityConfig struct

+ Identifiers []string

+ IssuersRaw []json.RawMessage

+ type RemoteAdmin struct

+ AccessControl []*AdminAccess

+ Listen string

type Replacer

+ func NewEmptyReplacer() *Replacer

May 3, 2021 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Apr 1, 2021 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Feb 15, 2021 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Dec 30, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Dec 30, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Dec 10, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Nov 30, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Nov 23, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Oct 13, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Oct 26, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Oct 13, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Sep 23, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Sep 18, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Sep 17, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Aug 11, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Jun 30, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Changes in this version

type Replacer

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

Jun 26, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Changes in this version

+ func PIDFile(filename string) error

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

Jun 26, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Jun 8, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

May 2, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Changes in this version

+ const ExitCodeFailedQuit

+ const ExitCodeFailedStartup

+ const ExitCodeForceQuit

+ const ExitCodeSuccess

+ const ImportPath

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

+ var DefaultAdminConfig = &AdminConfig

+ var DefaultAdminListen = "localhost:2019"

+ var DefaultStorage = &certmagic.FileStorage

+ var ErrInternalRedir = fmt.Errorf("internal redirect; re-authorization required")

+ func AppConfigDir() string

+ func AppDataDir() string

+ func GetModuleID(instance interface{}) string

+ func GetModuleName(instance interface{}) string

+ func GoModule() *debug.Module

+ func HomeDir() string

+ 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 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

+ Code int

+ Err error

+ Message string

+ func (e APIError) Error() string

+ type AdminConfig struct

+ Config *ConfigSettings

+ Disabled bool

+ EnforceOrigin bool

+ Listen string

+ Origins []string

+ 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 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 ConfigSettings struct

+ 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) 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 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 ReplacementFunc func(variable string, val interface{}) (interface{}, error)

+ type Replacer struct

+ func NewReplacer() *Replacer

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

+ func (r *Replacer) Get(variable string) (interface{}, 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

Apr 2, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Apr 13, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Apr 9, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Apr 2, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Nov 4, 2019 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Oct 29, 2019 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Oct 28, 2019 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Oct 14, 2019 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Oct 10, 2019 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Oct 7, 2019 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Oct 1, 2019 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Sep 20, 2019 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Jan 1, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Dec 23, 2019 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Nov 18, 2019 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Sep 13, 2019 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Mar 24, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Mar 23, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Mar 19, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Mar 14, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Mar 13, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Feb 28, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Feb 9, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2

Jan 22, 2020 GO-2023-1567

  GO-2023-1567: Open redirect in github.com/caddyserver/caddy/v2