Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Remove sh language hint from Caddyfile examples #207

Merged
merged 2 commits into from
Sep 23, 2024
Merged

docs: Remove sh language hint from Caddyfile examples #207

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cbe7515
Remove `sh` language hint from Caddyfile examples
camhux Sep 23, 2024
c576b1a
Fix mixed indentation chars to favor tabs in example Caddyfiles
camhux Sep 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,19 +118,19 @@ This allows you to hack on Caddy core (and optionally plug in extra modules at t

If `--embed` is used without an alias prefix, the contents of the source directory are written directly into the root directory of the embedded filesystem within the Caddy executable. The contents of multiple unaliased source directories will be merged together:

```sh
```
$ xcaddy build --embed ./my-files --embed ./my-other-files
$ 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
# 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
}

localhost {
# This serves the files or directories that were
# contained inside of ./my-files and ./my-other-files
# This serves the files or directories that were
# contained inside of ./my-files and ./my-other-files
file_server {
fs my_embeds
}
Expand All @@ -139,25 +139,25 @@ localhost {

You may also prefix the source directory with a custom alias and colon separator to write the source directory's contents to a separate subdirectory within the `embedded` filesystem:

```sh
```
$ xcaddy build --embed foo:./sites/foo --embed bar:./sites/bar
$ cat Caddyfile
{
filesystem my_embeds embedded
filesystem my_embeds embedded
}

foo.localhost {
# This serves the files or directories that were
# contained inside of ./sites/foo
# This serves the files or directories that were
# contained inside of ./sites/foo
root * /foo
file_server {
fs my_embeds
}
}

bar.localhost {
# This serves the files or directories that were
# contained inside of ./sites/bar
# This serves the files or directories that were
# contained inside of ./sites/bar
root * /bar
file_server {
fs my_embeds
Expand Down
Loading