Categorygithub.com/ThreeFx/caddy/v2
modulepackage
2.5.2
Repository: https://github.com/threefx/caddy.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
43
Dependents
0
Files
3.9k SLOC

# README

Caddy

a project

Every site on HTTPS

Caddy is an extensible server platform that uses TLS by default.


@caddyserver on Twitter Caddy Forum
Caddy on Sourcegraph Cloudsmith

Releases · Documentation · Get Help

Menu

Powered by
CertMagic

Features

  • Easy configuration with the Caddyfile
  • Powerful configuration with its native JSON config
  • Dynamic configuration with the JSON API
  • Config adapters if you don't like JSON
  • Automatic HTTPS by default
    • ZeroSSL and Let's Encrypt for public names
    • Fully-managed local CA for internal names & IPs
    • Can coordinate with other Caddy instances in a cluster
    • Multi-issuer fallback
  • Stays up when other servers go down due to TLS/OCSP/certificate-related issues
  • Production-ready after serving trillions of requests and managing millions of TLS certificates
  • Scales to tens of thousands of sites ... and probably more
  • HTTP/1.1, HTTP/2, and experimental HTTP/3 support
  • Highly extensible modular architecture lets Caddy do anything without bloat
  • Runs anywhere with no external dependencies (not even libc)
  • Written in Go, a language with higher memory safety guarantees than other servers
  • Actually fun to use
  • So, so much more to discover

Install

The simplest, cross-platform way is to download from GitHub Releases and place the executable file in your PATH.

For other install options, see https://caddyserver.com/docs/install.

Build from source

Requirements:

For development

Note: These steps will not embed proper version information. For that, please follow the instructions in the next section.

$ git clone "https://github.com/caddyserver/caddy.git"
$ cd caddy/cmd/caddy/
$ go build

When you run Caddy, it may try to bind to low ports unless otherwise specified in your config. If your OS requires elevated privileges for this, you will need to give your new binary permission to do so. On Linux, this can be done easily with: sudo setcap cap_net_bind_service=+ep ./caddy

If you prefer to use go run which only creates temporary binaries, you can still do this with the included setcap.sh like so:

$ go run -exec ./setcap.sh main.go

If you don't want to type your password for setcap, use sudo visudo to edit your sudoers file and allow your user account to run that command without a password, for example:

username ALL=(ALL:ALL) NOPASSWD: /usr/sbin/setcap

replacing username with your actual username. Please be careful and only do this if you know what you are doing! We are only qualified to document how to use Caddy, not Go tooling or your computer, and we are providing these instructions for convenience only; please learn how to use your own computer at your own risk and make any needful adjustments.

With version information and/or plugins

Using our builder tool, xcaddy...

$ xcaddy build

...the following steps are automated:

  1. Create a new folder: mkdir caddy
  2. Change into it: cd caddy
  3. Copy Caddy's main.go into the empty folder. Add imports for any custom plugins you want to add.
  4. Initialize a Go module: go mod init caddy
  5. (Optional) Pin Caddy version: go get github.com/caddyserver/caddy/v2@version replacing version with a git tag, commit, or branch name.
  6. (Optional) Add plugins by adding their import: _ "import/path/here"
  7. Compile: go build

Quick start

The Caddy website has documentation that includes tutorials, quick-start guides, reference, and more.

We recommend that all users -- regardless of experience level -- do our Getting Started guide to become familiar with using Caddy.

If you've only got a minute, the website has several quick-start tutorials to choose from! However, after finishing a quick-start tutorial, please read more documentation to understand how the software works. 🙂

Overview

Caddy is most often used as an HTTPS server, but it is suitable for any long-running Go program. First and foremost, it is a platform to run Go applications. Caddy "apps" are just Go programs that are implemented as Caddy modules. Two apps -- tls and http -- ship standard with Caddy.

Caddy apps instantly benefit from automated documentation, graceful on-line config changes via API, and unification with other Caddy apps.

Although JSON is Caddy's native config language, Caddy can accept input from config adapters which can essentially convert any config format of your choice into JSON: Caddyfile, JSON 5, YAML, TOML, NGINX config, and more.

The primary way to configure Caddy is through its API, but if you prefer config files, the command-line interface supports those too.

Caddy exposes an unprecedented level of control compared to any web server in existence. In Caddy, you are usually setting the actual values of the initialized types in memory that power everything from your HTTP handlers and TLS handshakes to your storage medium. Caddy is also ridiculously extensible, with a powerful plugin system that makes vast improvements over other web servers.

To wield the power of this design, you need to know how the config document is structured. Please see our documentation site for details about Caddy's config structure.

Nearly all of Caddy's configuration is contained in a single config document, rather than being scattered across CLI flags and env variables and a configuration file as with other web servers. This makes managing your server config more straightforward and reduces hidden variables/factors.

Full documentation

Our website has complete documentation:

https://caddyserver.com/docs/

The docs are also open source. You can contribute to them here: https://github.com/caddyserver/website

Getting help

  • We strongly recommend that all professionals or companies using Caddy get a support contract through Ardan Labs before help is needed.

  • A sponsorship goes a long way! If Caddy is benefitting your company, please consider a sponsorship! This not only helps fund full-time work to ensure the longevity of the project, it's also a great look for your company to your customers and potential customers!

  • Individuals can exchange help for free on our community forum at https://caddy.community. Remember that people give help out of their spare time and good will. The best way to get help is to give it first!

Please use our issue tracker only for bug reports and feature requests, i.e. actionable development items (support questions will usually be referred to the forums).

About

Matthew Holt began developing Caddy in 2014 while studying computer science at Brigham Young University. (The name "Caddy" was chosen because this software helps with the tedious, mundane tasks of serving the Web, and is also a single place for multiple things to be organized together.) It soon became the first web server to use HTTPS automatically and by default, and now has hundreds of contributors and has served trillions of HTTPS requests.

The name "Caddy" is trademarked. The name of the software is "Caddy", not "Caddy Server" or "CaddyServer". Please call it "Caddy" or, if you wish to clarify, "the Caddy web server". Caddy is a registered trademark of Stack Holdings GmbH.

Caddy is a project of ZeroSSL, a Stack Holdings company.

Debian package repository hosting is graciously provided by Cloudsmith. Cloudsmith is the only fully hosted, cloud-native, universal package management solution, that enables your organization to create, store and share packages in any format, to any place, with total confidence.

# Packages

No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Functions

AppConfigDir returns the directory where to store user's config.
AppDataDir returns a directory path that is suitable for storing application data on disk.
GetModule returns module information from its ID (full name).
GetModuleID returns a module's ID from an instance of its value.
GetModuleName returns a module's name (the last label of its ID) from an instance of its value.
GetModules returns all modules in the given scope/namespace.
GoModule returns the build info of this Caddy build from debug.BuildInfo (requires Go modules).
HomeDir returns the best guess of the current user's home directory from environment variables.
InstanceID returns the UUID for this instance, and generates one if it does not already exist.
JoinNetworkAddress combines network, host, and port into a single address string of the form accepted by ParseNetworkAddress().
Listen is like net.Listen, except Caddy's listeners can overlap each other: multiple listeners may be created on the same socket at the same time.
ListenPacket returns a net.PacketConn suitable for use in a Caddy module.
ListenQUIC returns a quic.EarlyListener suitable for use in a Caddy module.
Load loads the given config JSON and runs it only if it is different from the current config or forceReload is true.
Log returns the current default logger.
Modules returns the names of all registered modules in ascending lexicographical order.
NewContext provides a new context derived from the given context ctx.
NewEmptyReplacer returns a new Replacer, without the global default replacements.
NewReplacer returns a new Replacer.
NewUsagePool returns a new usage pool that is ready to use.
ParseDuration parses a duration string, adding support for the "d" unit meaning number of days, where a day is assumed to be 24h.
ParseNetworkAddress parses addr into its individual components.
ParseStructTag parses a caddy struct tag into its keys and values.
PIDFile writes a pidfile to the file at filename.
RegisterModule registers a module by receiving a plain/empty value of the module.
RemoveMetaFields removes meta fields like "@id" from a JSON message by using a simple regular expression.
Run runs the given config, replacing any existing config.
SplitNetworkAddress splits a into its network, host, and port components.
Stop stops running the current configuration.
TrapSignals create signal/interrupt handlers as best it can for the current OS.
Validate loads, provisions, and validates cfg, but does not start running it.

# Constants

Exit codes.
Exit codes.
Exit codes.
Exit codes.
ImportPath is the package import path for Caddy core.
ReplacerCtxKey is the context key for a replacer.

# Variables

ConfigAutosavePath is the default path to which the last config will be persisted.
DefaultAdminListen is the address for the local admin listener, if none is specified at startup.
DefaultRemoteAdminListen is the address for the remote (TLS-authenticated) admin listener, if enabled and not specified otherwise.
DefaultStorage is Caddy's default storage module.

# Structs

AdminAccess specifies what permissions an identity or group of identities are granted.
AdminConfig configures Caddy's API endpoint, which is used to manage Caddy while it is running.
AdminPermissions specifies what kinds of requests are allowed to be made to the admin endpoint.
AdminRoute represents a route for the admin endpoint.
APIError is a structured error that every API handler should return for consistency in logging and client responses.
Config is the top (or beginning) of the Caddy configuration structure.
ConfigSettings configures the management of configuration.
Context is a type which defines the lifetime of modules that are loaded and provides access to the parent configuration that spawned the modules which are loaded.
CustomLog represents a custom logger configuration.
No description provided by the author
IdentityConfig configures management of this server's identity.
Logging facilitates logging within Caddy.
LogSampling configures log entry sampling.
ModuleInfo represents a registered Caddy module.
NetworkAddress contains the individual components for a parsed network address of the form accepted by ParseNetworkAddress().
RemoteAdmin enables and configures remote administration.
Replacer can replace values in strings.
StandardLibLog configures the default Go standard library global logger in the log package.
No description provided by the author
No description provided by the author
UsagePool is a thread-safe map that pools values based on usage (reference counting).

# Interfaces

AdminHandler is like http.Handler except ServeHTTP may return an error.
AdminRouter is a type which can return routes for the admin API.
App is a thing that Caddy runs.
CleanerUpper is implemented by modules which may have side-effects such as opened files, spawned goroutines, or allocated some sort of non-stack state when they were provisioned.
ConfigLoader is a type that can load a Caddy config.
Destructor is a value that can clean itself up when it is deallocated.
ListenerWrapper is a type that wraps a listener so it can modify the input listener's methods.
Module is a type that is used as a Caddy module.
Provisioner is implemented by modules which may need to perform some additional "setup" steps immediately after being loaded.
StorageConverter is a type that can convert itself to a valid, usable certmagic.Storage value.
Validator is implemented by modules which can verify that their configurations are valid.
WriterOpener is a module that can open a log writer.

# Type aliases

AdminHandlerFunc is a convenience type like http.HandlerFunc.
Constructor is a function that returns a new value that can destruct itself when it is no longer needed.
CtxKey is a value type for use with context.WithValue.
Duration can be an integer or a string.
ModuleID is a string that uniquely identifies a Caddy module.
ModuleMap is a map that can contain multiple modules, where the map key is the module's name.
ReplacementFunc is a function that is called when a replacement is being performed.
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 is blank).