caddy-website/src/docs/markdown/caddyfile/directives/file_server.md

56 lines
2 KiB
Markdown
Raw Normal View History

2020-01-24 12:47:52 -07:00
---
title: file_server (Caddyfile directive)
---
# file_server
A static file server. It works by appending the request's URI path to the [site's root path](/docs/caddyfile/directives/root). 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`](/docs/caddyfile/directives/root) directive to set file root for the whole site.
2020-01-24 12:47:52 -07:00
## Syntax
```caddy-d
2020-01-24 12:47:52 -07:00
file_server [<matcher>] [browse] {
root <path>
hide <files...>
index <filenames...>
2020-01-24 12:47:52 -07:00
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`](/docs/caddyfile/directives/try_files) or [`templates`](/docs/caddyfile/directives/templates)) to know the same site root, use the [`root`](/docs/caddyfile/directives/root) directive, not this subdirective.
2020-01-24 12:47:52 -07:00
- **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`
2020-01-24 12:47:52 -07:00
- **<template_file>** is an optional custom template file to use for directory listings.
## Examples
A static file server out of the current directory:
```caddy-d
2020-01-24 12:47:52 -07:00
file_server
```
With file listings enabled:
```caddy-d
2020-01-24 12:47:52 -07:00
file_server browse
```
Only serve static files out of the `/static` folder:
```caddy-d
2020-01-24 12:47:52 -07:00
file_server /static/*
```
The `file_server` directive is usually paired with the [`root` directive](/docs/caddyfile/directives/root) to set the root path from which to serve files:
```caddy-d
root * /home/user/public_html
file_server
```