# Caddy

> This tutorial will show you how to use Caddy's [admin API](/docs/api), which makes it possible to automate in a programmable fashion.

## Pages

- [API Tutorial](api-tutorial.md): This tutorial will show you how to use Caddy's [admin API](/docs/api), which makes it possible to automate in a progr...
- [API](api.md): Caddy is configured through an administration endpoint which can be accessed via HTTP using a [REST <img src="/old/re...
- [Architecture](architecture.md): Architecture
- [Automatic HTTPS](automatic-https.md): **Caddy is the first and only web server to use HTTPS automatically _and by default_.**
- [Build from source](build.md): There are multiple options for building Caddy, if you need a customized build (e.g. with plugins):
- [Caddyfile Concepts](caddyfile-concepts.md): This document will help you learn about the HTTP Caddyfile in detail.
- [abort (Caddyfile directive)](caddyfile-directives-abort.md): Prevents any response to the client by immediately aborting the HTTP handler chain and closing the connection. Any co...
- [acme_server (Caddyfile directive)](caddyfile-directives-acme-server.md): An embedded [ACME protocol](https://tools.ietf.org/html/rfc8555) server handler. This allows a Caddy instance to issu...
- [basic_auth (Caddyfile directive)](caddyfile-directives-basic-auth.md): Enables HTTP Basic Authentication, which can be used to protect directories and files with a username and hashed pass...
- [bind (Caddyfile directive)](caddyfile-directives-bind.md): Overrides the interface to which the server's socket should bind.
- [encode (Caddyfile directive)](caddyfile-directives-encode.md): window.$(function() {
- [error (Caddyfile directive)](caddyfile-directives-error.md): Triggers an error in the HTTP handler chain, with an optional message and recommended HTTP status code.
- [file_server (Caddyfile directive)](caddyfile-directives-file-server.md): window.$(function() {
- [forward_auth (Caddyfile directive)](caddyfile-directives-forward-auth.md): window.$(function() {
- [fs (Caddyfile directive)](caddyfile-directives-fs.md): Sets which file system should be used for performing file I/O.
- [handle (Caddyfile directive)](caddyfile-directives-handle.md): Evaluates a group of directives mutually exclusively from other`handle`blocks at the same level of nesting.
- [handle_errors (Caddyfile directive)](caddyfile-directives-handle-errors.md): Sets up error handlers.
- [handle_path (Caddyfile directive)](caddyfile-directives-handle-path.md): window.$(function() {
- [header (Caddyfile directive)](caddyfile-directives-header.md): Manipulates HTTP response header fields. It can set, add, and delete header values, or perform replacements using reg...
- [import (Caddyfile directive)](caddyfile-directives-import.md): Includes a [snippet](/docs/caddyfile/concepts#snippets) or file, replacing this directive with the contents of the sn...
- [intercept (Caddyfile directive)](caddyfile-directives-intercept.md): window.$(function() {
- [invoke (Caddyfile directive)](caddyfile-directives-invoke.md): Invokes a [named route](/docs/caddyfile/concepts#named-routes).
- [log (Caddyfile directive)](caddyfile-directives-log.md): window.$(function() {
- [log_append (Caddyfile directive)](caddyfile-directives-log-append.md): Appends a field to the access log for the current request.
- [log_name (Caddyfile directive)](caddyfile-directives-log-name.md): Overrides the logger name to use for a request when writing access logs with the [`log`directive](log).
- [log_skip (Caddyfile directive)](caddyfile-directives-log-skip.md): Skips access logging for matched requests.
- [map (Caddyfile directive)](caddyfile-directives-map.md): Sets values of custom placeholders switched on an input value.
- [method (Caddyfile directive)](caddyfile-directives-method.md): Changes the HTTP method on the request.
- [metrics (Caddyfile directive)](caddyfile-directives-metrics.md): Configures a Prometheus metrics exposition endpoint so the gathered metrics can
- [php_fastcgi (Caddyfile directive)](caddyfile-directives-php-fastcgi.md): window.$(function() {
- [push (Caddyfile directive)](caddyfile-directives-push.md): Configures the server to pre-emptively send resources to the client using HTTP/2 server push.
- [redir (Caddyfile directive)](caddyfile-directives-redir.md): Issues an HTTP redirect to the client.
- [request_body (Caddyfile directive)](caddyfile-directives-request-body.md): Manipulates or sets restrictions on the bodies of incoming requests.
- [request_header (Caddyfile directive)](caddyfile-directives-request-header.md): Manipulates HTTP header fields on the request. It can set, add, and delete header values, or perform replacements usi...
- [respond (Caddyfile directive)](caddyfile-directives-respond.md): Writes a hard-coded/static response to the client.
- [reverse_proxy (Caddyfile directive)](caddyfile-directives-reverse-proxy.md): window.$(function() {
- [rewrite (Caddyfile directive)](caddyfile-directives-rewrite.md): Rewrites the request URI internally.
- [root (Caddyfile directive)](caddyfile-directives-root.md): Sets the root path of the site, used by various matchers and directives that access the file system. If unset, the de...
- [route (Caddyfile directive)](caddyfile-directives-route.md): Evaluates a group of directives literally and as a single unit.
- [templates (Caddyfile directive)](caddyfile-directives-templates.md): Executes the response body as a [template](/docs/modules/http.handlers.templates) document. Templates provide functio...
- [tls (Caddyfile directive)](caddyfile-directives-tls.md): window.$(function() {
- [tracing (Caddyfile directive)](caddyfile-directives-tracing.md): Enables integration with OpenTelemetry tracing facilities, using [`opentelemetry-go`<img src="/old/resources/images/...
- [try_files (Caddyfile directive)](caddyfile-directives-try-files.md): Rewrites the request URI path to the first of the listed files which exists in the site root. If no files match, no r...
- [uri (Caddyfile directive)](caddyfile-directives-uri.md): Manipulates a request's URI. It can strip path prefix/suffix or replace substrings on the whole URI.
- [vars (Caddyfile directive)](caddyfile-directives-vars.md): Sets one or more variables to a particular value, to be used later in the request handling chain.
- [Caddyfile Directives](caddyfile-directives.md): margin: 0 auto;
- [Request matchers (Caddyfile)](caddyfile-matchers.md): window.$(function() {
- [Global options (Caddyfile)](caddyfile-options.md): window.$(function() {
- [Common Caddyfile Patterns](caddyfile-patterns.md): This page demonstrates a few complete and minimal Caddyfile configurations for common use cases. These can be helpful...
- [Response matchers (Caddyfile)](caddyfile-response-matchers.md): window.$(function() {
- [Caddyfile Tutorial](caddyfile-tutorial.md): This tutorial will teach you the basics of the [HTTP Caddyfile](/docs/caddyfile) so that you can quickly and easily p...
- [The Caddyfile](caddyfile.md): The **Caddyfile** is a convenient Caddy configuration format for humans. It is most people's favorite way to use Cadd...
- [Command Line](command-line.md): Caddy has a standard unix-like command line interface. Basic usage is:
- [Config Adapters](config-adapters.md): Caddy's native config language is [JSON](https://www.json.org/json-en.html), but writing JSON by hand can be tedious ...
- [Conventions](conventions.md): The Caddy ecosystem adheres to a few conventions to make things consistent and intuitive across the platform.
- [Caddyfile Support](extending-caddy-caddyfile.md): Caddy modules are automatically added to the [native JSON config](/docs/json/) by virtue of their namespace when they...
- [Writing Config Adapters](extending-caddy-config-adapters.md): For various reasons, you may wish to configure Caddy using a format that is not [JSON](/docs/json/). Caddy has first-...
- [Module Namespaces](extending-caddy-namespaces.md): Caddy guest modules are loaded generically as`interface{}`or`any`types. In order for the host modules to be able ...
- [Placeholder Support](extending-caddy-placeholders.md): In Caddy, placeholders are processed by each individual plugin as needed; they do not automatically work everywhere.
- [Extending Caddy](extending-caddy.md): Caddy is easy to extend because of its modular architecture. Most kinds of Caddy extensions (or plugins) are known as...
- [Getting Started](getting-started.md): Welcome to Caddy! This tutorial will explore the basics of using Caddy and help you get familiar with it at a high le...
- [Welcome](index.md): Caddy is a powerful, extensible platform to serve your sites, services, and apps, written in Go. If you're new to Cad...
- [Install](install.md): This page describes various methods for installing Caddy on your system.
- [How Logging Works](logging.md): How Logging Works
- [Monitoring Caddy with Prometheus metrics](metrics.md): Whether you're running thousands of Caddy instances in the cloud, or a single
- [Profiling Caddy](profiling.md): Profiling Caddy
- [API Quick-start](quick-starts-api.md): **Prerequisites:**
- [Caddyfile Quick-start](quick-starts-caddyfile.md): Create a new text file named`Caddyfile`(no extension).
- [HTTPS quick-start](quick-starts-https.md): This guide will show you how to get up and running with [fully-managed HTTPS](/docs/automatic-https) in no time.
- [Reverse proxy quick-start](quick-starts-reverse-proxy.md): This guide will show you how to get a production-ready reverse proxy with or without HTTPS up and running quickly.
- [Static files quick-start](quick-starts-static-files.md): This guide will show you how to get a production-ready static file server up and running quickly.
- [Quick-starts](quick-starts.md): These tutorials are designed to get you up and running quickly without much explanation to get in the way.
- [Keep Caddy Running](running.md): While Caddy can be run directly with its [command line interface](/docs/command-line), there are numerous advantages ...
- [Verifying Asset Signatures](signature-verification.md): Artifact signing allows you to validate the artifact you have is the same one created by the project's workflow and w...
- [Upgrading to Caddy 2](v2-upgrade.md): Upgrade Guide