mirrors/caddy-website
1
0
Fork 0
mirror of https://github.com/caddyserver/website.git synced 2025-04-21 12:36:16 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

cli: document the new command file-server export-template (#333)

Browse source
This commit is contained in:
Mohammed Al Sahaf 2023-07-17 07:18:58 +02:00 • committed by GitHub
parent 17dcddef01
commit 0a8e6ef86b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
src/docs/markdown/caddyfile/directives/file_server.md
View file

@ -48,7 +48,7 @@ file_server [<matcher>] [browse] {
- **browse** <span id="browse"/> enables file listings for requests to directories that do not have an index file.
- **<template_file>** <span id="template_file"/> is an optional custom template file to use for directory listings. Defaults to the template that can be found [here in the source code ![external link](/resources/images/external-link.svg)](https://github.com/caddyserver/caddy/blob/master/modules/caddyhttp/fileserver/browse.html). Browse templates can use actions from [the standard templates module](/docs/modules/http.handlers.templates#docs) as well.
- **<template_file>** <span id="template_file"/> is an optional custom template file to use for directory listings. Defaults to the template that can be extracted using the command `caddy file-server export-template`, which will print the defaut template to stdout. The embedded template can also be found [here in the source code ![external link](/resources/images/external-link.svg)](https://github.com/caddyserver/caddy/blob/master/modules/caddyhttp/fileserver/browse.html). Browse templates can use actions from [the standard templates module](/docs/modules/http.handlers.templates#docs) as well.
- **precompressed** <span id="precompressed"/> is the list of encoding formats to search for precompressed sidecar files. Arguments are an ordered list of encoding formats to search for precompressed [sidecar files](https://en.wikipedia.org/wiki/Sidecar_file). Supported formats are `gzip` (`.gz`), `zstd` (`.zst`) and `br` (`.br`).

7
src/docs/markdown/command-line.md
View file

@ -35,6 +35,9 @@ The ellipses `...` indicates a continuation, i.e. one or more parameters.
- **[caddy file-server](#caddy-file-server)**
A simple but production-ready file server
- **[caddy file-server export-template](#caddy-file-server-export-template)**
Auxilary command for the file server to export the default file browser template
- **[caddy fmt](#caddy-fmt)**
Formats a Caddyfile
@ -202,7 +205,11 @@ Spins up a simple but production-ready static file server.
This command disables the admin API, making it easier to run multiple instances on a local development machine.
#### `caddy file-server export-template`
<pre><code class="cmd bash">caddy file-server export-template</code></pre>
Exports the default file browsing template to stdout
### `caddy fmt`