This page is about Caddy 2. If you still need v1 docs for a limited time, click here.
Documentation

file_server

A static file server. It works by appending the request's URI path to the site's root path. By default, it enforces canonical URIs; if necessary, requests to directories will be redirected to have a trailing forward slash, and requests to files will be redirected to strip the trailing slash.

Most often, the file_server directive is paired with the root directive to set file root for the whole site.

Syntax

file_server [<matcher>] [browse] {
	root   <path>
	hide   <files...>
	index  <filenames...>
	browse [<template_file>]
}
  • browse enables file listings for requests to directories that do not have an index file.
  • root sets the path to the site root for just this file server instance, overriding any other. Default: {http.vars.root} or the current working directory. Note: This subdirective only changes the root for this directive. For other directives (like try_files or templates) to know the same site root, use the root directive, not this subdirective.
  • hide is a list of files to hide; if requested, the file server will pretend they do not exist. The active configuration file will be added by default.
  • index is a list of filenames to look for as index files. Default: index.html index.txt
  • <template_file> is an optional custom template file to use for directory listings.

Examples

A static file server out of the current directory:

file_server

With file listings enabled:

file_server browse

Only serve static files out of the /static folder:

file_server /static/*

The file_server directive is usually paired with the root directive to set the root path from which to serve files:

root * /home/user/public_html
file_server