Jump to content

Caddy (web server)

From Wikipedia, the free encyclopedia
Caddy
Original author(s)Matthew Holt
Initial release28 April 2015; 9 years ago (2015-04-28)
Stable release
2.8.4[1] Edit this on Wikidata / 2 June 2024; 2 months ago (2 June 2024)
Repositorygithub.com/caddyserver/caddy
Written inGo[2]
Operating systemBSD variants, Linux, Plan 9, macOS and Windows
PlatformIA-32 (i386), x86-64, ARM, MIPS, S390X
TypeWeb server, reverse proxy server
LicenseApache 2
Websitecaddyserver.com Edit this at Wikidata

Caddy is an extensible, cross-platform, open-source web server written in Go.

The name "Caddy" refers both to a helper for tedious tasks, and a way to organize multiple parts into a simplified system.[3] At its core, Caddy is an extensible platform for deploying long-running services ("apps") using a single, unified configuration that can be updated on-line with a REST API.[4] Official Caddy distributions ship with a set of standard modules which include HTTP server, TLS automation, and PKI apps.[5] It is best known for its automatic HTTPS features.[6][7]

Architecture

[edit]

Caddy is organized into three main components: a command, the core library, and configuration modules.[8] The command is the extensible interface by which the program is executed; it can also load configuration files, run common modes, manage installed plugins, and offer relevant utility functions. The core library has APIs for loading, unloading, and managing configuration; but it does nothing particularly useful on its own. Most of Caddy's functionality is provided by modules, which are plugins that extend Caddy's configuration structure; for example, the HTTP server is a module.[9] Caddy modules implement various long-running services, web standards, and other useful features.

Caddy's input is a JSON configuration document[10] which is received through an open socket via a RESTful HTTP API.[11][6] In the absence of an HTTP client, Caddy's command-line interface can be used to load configuration files.[12] Config adapters may be used to convert other configuration formats to JSON. Existing adapters include the Caddyfile, which has first-class support in the command line; and YAML, TOML, Nginx, and several other formats.[13][6]

When a configuration is received through its administration socket, Caddy decodes the configuration for all the specified modules, and starts running all the app modules.[6] When the app modules are being provisioned, they themselves may load and provision modules that they use. For example, the HTTP server is an app module which uses HTTP handler modules to handle HTTP requests; these handlers might use yet other modules to implement their functionality, and so on.[14] All these modules are provisioned during the config load phase.[8]

Plugins are installed by statically compiling them directly into the Caddy binary.[3][6] Without plugins, Caddy's native configuration structure only has some basic options for administration and logging.[10] All other functionality must be provided by app modules. Official Caddy distributions ship with dozens of standard modules;[5] others can be added from the project's website,[15] using the xcaddy command line tool, or by manually compiling a custom build.[16]

Miek Gieben forked Caddy to use as the core of CoreDNS, now a project of the Cloud Native Computing Foundation, as he appreciated its overall architecture and simplicity of its configuration.[17]

HTTP server

[edit]

The HTTP server is an app module that comes standard with official Caddy distributions.[9] It is primarily used as a static file server[18] and load-balancing reverse proxy.[19] While the basis of Caddy's HTTP features use the implementation found in Go's standard library,[20] a variety enhancements and customizations are available as middleware and exposed through configuration parameters:[6]

By default, TLS is used automatically if any routes have a non-empty host matcher.[21] These are assumed to be site names or IP addresses that Caddy is serving, so Caddy will automatically procure and renew certificates for the configured hostnames and IP addresses. When automatic HTTPS is activated in this manner, Caddy will also redirect HTTP requests to their equivalent HTTPS location.

Development

[edit]

Caddy version 2 was released on May 5, 2020.[7] Reviewers say that it still has a simpler configuration file syntax than the Apache Web Server, although version 2's configuration format is largely incompatible with the previous major release of Caddy.[7][22]

References

[edit]
  1. ^ "Release 2.8.4". 2 June 2024. Retrieved 20 June 2024.
  2. ^ Gerrand, Andrew (17 February 2016). "Go 1.6 is released". golang.org. Retrieved 5 March 2016.
  3. ^ a b README.md, caddyserver/caddy on GitHub, 2021-09-27, retrieved 2021-09-27
  4. ^ "Welcome - Caddy Documentation". caddyserver.com. Archived from the original on 2015-05-02. Retrieved 2021-09-27.
  5. ^ a b imports.go, caddyserver/caddy on GitHub, 2021-09-27, retrieved 2021-09-27
  6. ^ a b c d e f Woodbeck, Adam (2021). Network programming with GO : code secure and reliable network services from Scratch. San Francisco, CA. pp. 217–239. ISBN 978-1-7185-0088-4. OCLC 1198449668.{{cite book}}: CS1 maint: location missing publisher (link)
  7. ^ a b c Jim Salter (May 6, 2020). "Caddy offers TLS, HTTPS, and more in one dependency-free Go Web server". Ars Technica. Retrieved June 12, 2023.
  8. ^ a b "Architecture - Caddy Documentation". caddyserver.com. Archived from the original on 2020-04-14. Retrieved 2021-09-27.
  9. ^ a b "Module http - Caddy Documentation". caddyserver.com. Archived from the original on 2020-05-06. Retrieved 2021-09-27.
  10. ^ a b "JSON Config Structure - Caddy Documentation". caddyserver.com. Archived from the original on 2020-04-14. Retrieved 2021-09-27.
  11. ^ "API - Caddy Documentation". caddyserver.com. Archived from the original on 2020-03-02. Retrieved 2021-09-27.
  12. ^ "Command Line - Caddy Documentation". caddyserver.com. Archived from the original on 2020-03-02. Retrieved 2021-09-27.
  13. ^ "Config Adapters - Caddy Documentation". caddyserver.com. Archived from the original on 2020-04-14. Retrieved 2021-09-27.
  14. ^ Holt, Matthew (2019-12-04), The Engineering Challenges of long running go programs, Forge Utah, retrieved 2021-09-27
  15. ^ "Download Caddy". caddyserver.com. Archived from the original on 2015-05-02. Retrieved 2021-09-27.
  16. ^ "Build from source - Caddy Documentation". caddyserver.com. Archived from the original on 2020-05-29. Retrieved 2021-09-27.
  17. ^ John Balemaric; Cricket Liu (2019). Learning CoreDNS. "O'Reilly Media, Inc.". ISBN 9781492047919. Retrieved 12 June 2023.
  18. ^ "Static files quick-start - Caddy Documentation". caddyserver.com. Archived from the original on 2020-05-08. Retrieved 2021-09-27.
  19. ^ "Reverse proxy quick-start - Caddy Documentation". caddyserver.com. Archived from the original on 2020-05-08. Retrieved 2021-09-27.
  20. ^ Holt, Matthew (2015-05-27). "A Look Inside Caddy, a Web Server Written in Go". blog.gopheracademy.com. Archived from the original on 2015-05-30. Retrieved 2021-09-27.
  21. ^ "Automatic HTTPS - Caddy Documentation". caddyserver.com. Archived from the original on 2016-03-04. Retrieved 2021-09-27.
  22. ^ Jack Wallen (May 26, 2022). "How to deploy a single web page to the Caddy server from a Caddyfile". TechRepublic. Retrieved 12 June 2023.
[edit]
Retrieved from "https://en.wikipedia.org/w/index.php?title=Caddy_(web_server)&oldid=1202934778"