Caddy(8)

✨ Caddy(8) — the file-server girlies' manual ✨

okay so bestie, this is the Caddy(8) page, specifically the caddy-file-server one, and it is literally the cutest way to serve files. let's get into it 💖

---

🌸 NAME 🌸

caddy-file-server — Spins up a production-ready file server

like. it just does that. no cap. ✨

---

🦋 SYNOPSIS 🦋

caddy file-server [--domain ] [--root ] [--listen ] [--browse]
[--reveal-symlinks] [--access-log] [--precompressed] [flags]

---

💅 DESCRIPTION 💅

A simple but production-ready file server. Useful for quick deployments, demos, and development.

The listener's socket address can be customized with the --listen flag.

If a domain name is specified with --domain, the default listener address will be changed to the HTTPS port and the server will use HTTPS. If using a public domain, ensure A/AAAA records are properly configured before using this option. 👑 (yes queen, configure your DNS first, i'm begging)

By default, Zstandard and Gzip compression are enabled. Use --no-compress to disable compression.

If --browse is enabled, requests for folders without an index file will respond with a file listing. it's giving open house energy 🏠

---

🎀 OPTIONS 🎀

• -a, --access-log[=false] — Enable the access log. she logs everything, and honestly? valid.
• -b, --browse[=false] — Enable directory browsing
• -v, --debug[=false] — Enable verbose debug logs. main character energy for your terminal 🌈
• -d, --domain="" — Domain name at which to serve the files
• -f, --file-limit=10000 — Max directories to read. yes bestie there is a cap at 10000, respect it 💀
• -h, --help[=false] — help for file-server
• -l, --listen="" — The address to which to bind the listener
• --no-compress[=false] — Disable Zstandard and Gzip compression. turning off the glow-up, smh
• -p, --precompressed=[] — Specify precompression file extensions. Compression preference implied from flag order. (order matters, so like, don't just throw them in there 🙈)
• --reveal-symlinks[=false] — Show symlink paths when browse is enabled.
• -r, --root="" — The path to the root of the site
• -t, --templates[=false] — Enable template rendering. slay, you can template now ✨

---

🔥 SEE ALSO 🔥

• caddy(8) — the mothership manual
• caddy-file-server-export-template(8) — her bestie, the export-template one

iykyk 🫶

---

💜 HISTORY 💜

1-Jan-0001 Auto generated by spf13/cobra

---

fr fr, that's the whole page. no secrets, no missing flags, we keep it 100 💯

and that's a wrap on this one, bestie 🎀 — generated by spf13/cobra, dated Jan 0001, and yeah, it's the Caddy(8) manual, so go forth and serve those files. periodt. 💖✨🦋