Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

caddy

package module

Go to main page

Versions in this module

v2

v2.4.2

Nov 2, 2020

v2.4.1

Nov 2, 2020

v2.4.0

Nov 2, 2020

v2.3.5

Nov 2, 2020

v2.3.4

Nov 2, 2020

v2.3.2

Nov 2, 2020

Changes in this version

+ func GetCertificatePaths() (string, string)

+ func GetTLSConfig() *tls.Config

v2.3.1

Nov 2, 2020

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

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

Other modules containing this package

github.com/freemind-lj/caddy