Mirrors/xcaddy
1
0
Fork 0
mirror of https://github.com/caddyserver/xcaddy.git synced 2025-02-02 06:07:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: Add embedded filesystem declaration to --embed example (#204)

Browse source 
* Add `embedded` filesystem declaration to `--embed` example

Also mention the filesystem explicitly in the preceding sentence

* Revise to avoid stutter in fs name and module name

* Add an explanatory comment to example Caddyfile as well
This commit is contained in:
Cameron Martin 2024-09-20 15:55:07 -07:00 committed by GitHub
parent b72e330d5d
commit 16f248e6d1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -116,22 +116,29 @@ This allows you to hack on Caddy core (and optionally plug in extra modules at t
--- ---
You may embed directories into the Caddy executable: You may embed directories into the Caddy executable and serve them from the `embedded` filesystem module:
``` ```
$ xcaddy build --embed foo:./sites/foo --embed bar:./sites/bar $ xcaddy build --embed foo:./sites/foo --embed bar:./sites/bar
$ cat Caddyfile $ cat Caddyfile
{
# You must declare a custom filesystem using the `embedded` module.
# The first argument to `filesystem` is an arbitrary identifier
# that will also be passed to `fs` directives.
filesystem my_embeds embedded
}
foo.localhost { foo.localhost {
root * /foo root * /foo
file_server { file_server {
fs embedded fs my_embeds
} }
} }
bar.localhost { bar.localhost {
root * /bar root * /bar
file_server { file_server {
fs embedded fs my_embeds
} }
} }
``` ```