Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/caddyserver/caddy
/ types & classes
Types & classes
525 in github.com/caddyserver/caddy
⨍
Functions
2,647
◇
Types & classes
525
↓ 43 callers
Struct
Flags
Flags wraps a FlagSet so that typed values from flags can be easily retrieved.
cmd/main.go:305
↓ 37 callers
FuncType
HandlerFunc
HandlerFunc is a convenience type like http.HandlerFunc.
modules/caddyhttp/caddyhttp.go:70
↓ 18 callers
TypeAlias
WeakString
WeakString is a type that unmarshals any JSON value as a string literal, with the following exceptions: 1. actual string values are decoded as string
modules/caddyhttp/caddyhttp.go:162
↓ 5 callers
FuncType
AdminHandlerFunc
AdminHandlerFunc is a convenience type like http.HandlerFunc.
admin.go:1365
↓ 4 callers
TypeAlias
MatchProtocol
MatchProtocol matches requests by protocol. Recognized values are "http", "https", and "grpc" for broad protocol matches, or specific HTTP versions ca
modules/caddyhttp/matchers.go:178
↓ 4 callers
FuncType
ReplacerFunc
ReplacerFunc is a function that returns a replacement for the given key along with true if the function is able to service that key (even if the value
replacer.go:337
↓ 4 callers
TypeAlias
fileMode
fileMode is a string made of 1 to 4 octal digits representing a numeric mode as specified with the `chmod` unix command. `"0777"` and `"777"` are thus
modules/logging/filewriter.go:42
↓ 3 callers
TypeAlias
LoggableStringArray
LoggableStringArray makes a slice of strings marshalable for logging.
internal/logmarshalers.go:37
↓ 3 callers
TypeAlias
PublicKeyAlgorithm
PublicKeyAlgorithm is a JSON-unmarshalable wrapper type.
modules/caddytls/connpolicy.go:1049
↓ 2 callers
TypeAlias
ACMEChallenge
ACMEChallenge is an opaque string that represents supported ACME challenges.
modules/caddypki/acmeserver/challenges.go:12
↓ 2 callers
TypeAlias
MatchHeader
MatchHeader matches requests by header fields. The key is the field name and the array is the list of field values. It performs fast, exact string com
modules/caddyhttp/matchers.go:163
↓ 2 callers
TypeAlias
MatchHost
MatchHost matches requests by the Host value (case-insensitive). When used in a top-level HTTP route, [qualifying domain names](/docs/automatic-https
modules/caddyhttp/matchers.go:65
↓ 2 callers
TypeAlias
StringArray
StringArray is a slices of strings, but also accepts a single string as a value when JSON unmarshaling, converting it to a slice of one string.
modules/caddyhttp/logging.go:174
↓ 2 callers
TypeAlias
byName
modules/caddyhttp/fileserver/browsetplcontext.go:321
↓ 2 callers
TypeAlias
byNameDirFirst
modules/caddyhttp/fileserver/browsetplcontext.go:322
↓ 2 callers
TypeAlias
bySize
modules/caddyhttp/fileserver/browsetplcontext.go:323
↓ 2 callers
TypeAlias
byTime
modules/caddyhttp/fileserver/browsetplcontext.go:324
↓ 2 callers
FuncType
nextHandler
func(http.ResponseWriter, *http.Request) error
modules/caddyhttp/headers/headers_test.go:270
↓ 2 callers
TypeAlias
testAddr
modules/caddytls/matchers_test.go:313
↓ 1 callers
TypeAlias
Duration
Duration can be an integer or a string. An integer is interpreted as nanoseconds. If a string, it is a Go time.Duration value such as `300ms`, `1.5h`,
caddy.go:868
↓ 1 callers
TypeAlias
LoggableTLSConnState
LoggableTLSConnState makes a TLS connection state loggable with zap.Object().
modules/caddyhttp/marshalers.go:71
↓ 1 callers
TypeAlias
MatchMethod
MatchMethod matches requests by the method.
modules/caddyhttp/matchers.go:121
↓ 1 callers
TypeAlias
MatchPath
MatchPath case-insensitively matches requests by the URI's path. Path matching is exact, not prefix-based, giving you more control and clarity over ma
modules/caddyhttp/matchers.go:108
↓ 1 callers
TypeAlias
MatchQuery
MatchQuery matches requests by the URI's query string. It takes a JSON object keyed by the query keys, with an array of string values to match for tha
modules/caddyhttp/matchers.go:147
↓ 1 callers
TypeAlias
MatchServerName
MatchServerName matches based on SNI. Names in this list may use left-most-label wildcards, similar to wildcard certificates.
modules/caddytls/matchers.go:48
↓ 1 callers
TypeAlias
Policy
modules/caddyhttp/proxyprotocol/policy.go:11
↓ 1 callers
TypeAlias
Positional
Positional are the supported modes for ordering directives.
caddyconfig/httpcaddyfile/directives.go:632
↓ 1 callers
FuncType
ShouldBufferFunc
ShouldBufferFunc is a function that returns true if the response should be buffered, given the pending HTTP status code and response headers.
modules/caddyhttp/responsewriter.go:329
↓ 1 callers
TypeAlias
VarsMatcher
VarsMatcher is an HTTP request matcher which can match requests based on variables in the context or placeholder values. The key is the placeholder or
modules/caddyhttp/vars.go:135
↓ 1 callers
TypeAlias
customCertLifetime
customCertLifetime allows us to customize certificates that are issued by Smallstep libs, particularly the NotBefore & NotAfter dates.
modules/caddytls/internalissuer.go:192
↓ 1 callers
TypeAlias
loggableURLArray
admin.go:1418
↓ 1 callers
TypeAlias
nopSyncer
modules/caddyhttp/server_test.go:24
TypeAlias
ACMEChallenges
ACMEChallenges is a list of ACME challenges.
modules/caddypki/acmeserver/challenges.go:48
Struct
ACMEIssuer
ACMEIssuer manages certificates using the ACME protocol (RFC 8555).
modules/caddytls/acmeissuer.go:45
Struct
APIError
APIError is a structured error that every API handler should return for consistency in logging and client responses. If Message is unset, then Err.Err
admin.go:1376
Struct
AUpstreams
AUpstreams provides upstreams from A/AAAA lookups. Results are cached and refreshed at the configured refresh interval.
modules/caddyhttp/reverseproxy/upstreams.go:281
Struct
Account
Account contains a username and password.
modules/caddyhttp/caddyauth/basicauth.go:284
Struct
ActiveHealthChecks
ActiveHealthChecks holds configuration related to active health checks (that is, health checks which occur in a background goroutine independently).
modules/caddyhttp/reverseproxy/healthchecks.go:73
Interface
Adapter
Adapter is a type which can adapt a configuration to Caddy JSON. It returns the results and any warnings, or an error.
caddyconfig/configadapters.go:26
Struct
Adapter
Adapter adapts Caddyfile to Caddy JSON.
caddyconfig/caddyfile/adapter.go:27
Struct
Address
Address represents a site address. It contains the original input value, and the component parts of an address. The component parts may be updated to
caddyconfig/httpcaddyfile/addresses.go:367
Struct
AdminAccess
AdminAccess specifies what permissions an identity or group of identities are granted.
admin.go:195
Struct
AdminConfig
AdminConfig configures Caddy's API endpoint, which is used to manage Caddy while it is running.
admin.go:71
Interface
AdminHandler
AdminHandler is like http.Handler except ServeHTTP may return an error. If any handler encounters an error, it should be returned for proper handling
admin.go:1360
Struct
AdminMetrics
AdminMetrics is a module that serves a metrics endpoint so that any gathered metrics can be exposed for scraping. This module is not configurable, and
modules/metrics/adminmetrics.go:35
Struct
AdminPermissions
AdminPermissions specifies what kinds of requests are allowed to be made to the admin endpoint.
admin.go:210
Struct
AdminRoute
AdminRoute represents a route for the admin endpoint.
admin.go:762
Interface
AdminRouter
AdminRouter is a type which can return routes for the admin API.
admin.go:757
Interface
App
App is a thing that Caddy runs.
caddy.go:98
Struct
App
App is a robust, production-ready HTTP server. HTTPS is enabled by default if host matchers with qualifying names are used in any of routes; certific
modules/caddyhttp/app.go:115
Struct
App
App implements a global eventing system within Caddy. Modules can emit and subscribe to events, providing hooks into deep parts of the code base that
modules/caddyevents/app.go:72
Struct
App
App represents the configuration for a non-standard Caddy app module (e.g. third-party plugin) which was parsed from a global options block.
caddyconfig/httpcaddyfile/httptype.go:45
Struct
AppendEncoder
AppendEncoder can be used to add fields to all log entries that pass through it. It is a wrapper around another encoder, which it uses to actually enc
modules/logging/appendencoder.go:44
Struct
Argon2idHash
Argon2idHash implements the Argon2id password hashing.
modules/caddyhttp/caddyauth/argon2id.go:44
Struct
Authentication
Authentication is a middleware which provides user authentication. Rejects requests with HTTP 401 if the request is not authenticated. After a succes
modules/caddyhttp/caddyauth/caddyauth.go:51
Interface
Authenticator
Authenticator is a type which can authenticate a request. If a request was not authenticated, it returns false. An error is only returned if authentic
modules/caddyhttp/caddyauth/caddyauth.go:137
Struct
AuthorityConfig
AuthorityConfig is used to help a CA configure the underlying signing authority.
modules/caddypki/ca.go:456
Struct
AutoHTTPSConfig
AutoHTTPSConfig is used to disable automatic HTTPS or certain aspects of it for a specific server. HTTPS is enabled automatically and by default when
modules/caddyhttp/autohttps.go:36
TypeAlias
AutomateLoader
AutomateLoader will automatically manage certificates for the names in the list, including obtaining and renewing certificates. Automated certificates
modules/caddytls/tls.go:1031
Struct
AutomationConfig
AutomationConfig governs the automated management of TLS certificates.
modules/caddytls/automation.go:37
Struct
AutomationPolicy
AutomationPolicy designates the policy for automating the management (obtaining, renewal, and revocation) of managed TLS certificates. An AutomationP
modules/caddytls/automation.go:91
Struct
BaseLog
BaseLog contains the common logging parameters for logging.
logging.go:300
Struct
BcryptHash
BcryptHash implements the bcrypt hash.
modules/caddyhttp/caddyauth/bcrypt.go:36
Struct
BrotliPrecompressed
BrotliPrecompressed provides the file extension for files precompressed with brotli encoding.
modules/caddyhttp/encode/brotli/brotli_precompressed.go:13
Struct
Browse
Browse configures directory browsing.
modules/caddyhttp/fileserver/browse.go:53
Interface
BufferedTransport
BufferedTransport is implemented by transports that needs to buffer requests and/or responses.
modules/caddyhttp/reverseproxy/reverseproxy.go:1763
Interface
CA
The interface to be implemented by all guest modules part of the namespace 'tls.ca_pool.source.'
modules/caddytls/capools.go:37
Struct
CA
CA describes a certificate authority, which consists of root/signing certificates and various settings pertaining to the issuance of certificates and
modules/caddypki/ca.go:40
Interface
CELLibraryProducer
CELLibraryProducer provide CEL libraries that expose a Matcher implementation as a first class function within the CEL expression matcher.
modules/caddyhttp/celmatcher.go:366
Struct
Cache
Cache enables caching of basic auth results. This is especially helpful for secure password hashes which can be expensive to compute on every HTTP req
modules/caddyhttp/caddyauth/basicauth.go:222
Interface
CachingUpstreamSource
CachingUpstreamSource is an upstream source that caches its upstreams. The relevant cache entry can be cleared/reset for a given request during retrie
modules/caddyhttp/reverseproxy/reverseproxy.go:1699
Struct
CertCacheOptions
CertCacheOptions configures the certificate cache.
modules/caddytls/tls.go:1042
Struct
CertKeyFilePair
CertKeyFilePair pairs certificate and key file names along with their encoding format so that they can be loaded from disk.
modules/caddytls/fileloader.go:63
Struct
CertKeyPEMPair
CertKeyPEMPair pairs certificate and key PEM blocks.
modules/caddytls/pemloader.go:61
Struct
Certificate
Certificate is a TLS certificate, optionally associated with arbitrary tags.
modules/caddytls/tls.go:1016
Interface
CertificateLoader
CertificateLoader is a type that can load certificates. Certificates can optionally be associated with tags.
modules/caddytls/tls.go:1010
Interface
CertificateProvider
CertificateProvider is an optional interface that CA pool sources can implement to expose their underlying certificates for combining.
modules/caddytls/capools.go:43
Struct
ChainPreference
ChainPreference describes the client's preferred certificate chain, useful if the CA offers alternate chains. The first matching chain will be selecte
modules/caddytls/acmeissuer.go:753
Struct
ChallengesConfig
ChallengesConfig configures the ACME challenges.
modules/caddytls/automation.go:506
Interface
CircuitBreaker
CircuitBreaker is a type that can act as an early-warning system for the health checker when backends are getting overloaded. This interface is still
modules/caddyhttp/reverseproxy/healthchecks.go:263
Interface
CleanerUpper
CleanerUpper is implemented by modules which may have side-effects such as opened files, spawned goroutines, or allocated some sort of non-stack state
modules.go:315
Struct
ClientAuthentication
ClientAuthentication configures TLS client auth.
modules/caddytls/connpolicy.go:590
Interface
ClientCertificateVerifier
ClientCertificateVerifier is a type which verifies client certificates. It is called during verifyPeerCertificate in the TLS handshake.
modules/caddytls/connpolicy.go:1076
Struct
ClientIPHashSelection
ClientIPHashSelection is a policy that selects a host based on hashing the client IP of the request, as determined by the HTTP app's trusted proxies s
modules/caddyhttp/reverseproxy/selectionpolicies.go:398
Struct
CloudEvent
CloudEvent is a JSON-serializable structure that is compatible with the CloudEvents specification. See https://cloudevents.io. EXPERIMENTAL: Subject t
caddy.go:1181
Struct
CombinedCAPool
The `combined` pool type merges multiple pools. The `sources` pools must implement the `CertificateProvider` interface, which allows them to export th
modules/caddytls/capools.go:830
Struct
Command
Command represents a subcommand. Name, Func, and Short are required.
cmd/commands.go:33
FuncType
CommandFunc
CommandFunc is a command's function. It runs the command and returns the proper exit code along with any error that occurred.
cmd/commands.go:79
Interface
Comparer
Comparer is a type that can securely compare a plaintext password with a hashed password in constant-time. Comparers should hash the plaintext passwor
modules/caddyhttp/caddyauth/basicauth.go:264
Struct
ComplexShorthandReplacer
caddyconfig/httpcaddyfile/shorthands.go:10
Struct
Config
Config is the top (or beginning) of the Caddy configuration structure. Caddy config is expressed natively as a JSON document. If you prefer not to wor
caddy.go:68
Struct
Config
Config store any configuration required to make the tests run
caddytest/caddytest.go:35
Interface
ConfigLoader
ConfigLoader is a type that can load a Caddy config. If the return value is non-nil, it must be valid Caddy JSON; if nil or with non-nil error, it is
caddy.go:684
Interface
ConfigSetter
ConfigSetter is implemented by certmagic.Issuers that need access to a parent certmagic.Config as part of their provisioning phase. For example, the A
modules/caddytls/automation.go:614
Struct
ConfigSettings
ConfigSettings configures the management of configuration.
admin.go:126
Struct
ConfigValue
ConfigValue represents a value to be added to the final configuration, or a value to be consulted when building the final configuration.
caddyconfig/httpcaddyfile/directives.go:429
Interface
ConfiguresFormatterDefault
ConfiguresFormatterDefault is an optional interface that encoder modules can implement to configure the default format of their encoder. This is usefu
logging.go:813
Interface
ConnectionMatcher
ConnectionMatcher is a type which matches TLS handshakes.
modules/caddytls/connpolicy.go:1064
TypeAlias
ConnectionPolicies
ConnectionPolicies govern the establishment of TLS connections. It is an ordered group of connection policies; the first matching policy will be used
modules/caddytls/connpolicy.go:47
Struct
ConnectionPolicy
ConnectionPolicy specifies the logic for handling a TLS handshake. An empty policy is valid; safe and sensible defaults will be used.
modules/caddytls/connpolicy.go:185
next →
1–100 of 525, ranked by callers