mirrors/caddy-website
1
0
Fork 0
mirror of https://github.com/caddyserver/website.git synced 2025-06-15 10:44:44 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

links

Browse source
This commit is contained in:
a 2024-07-25 15:59:00 -05:00
parent 70699deedd
commit adf3b672af
No known key found for this signature in database
GPG key ID: 374BC539FE795AF0
1 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
src/docs/markdown/extending-caddy/placeholders.md
View file

@ -21,7 +21,7 @@ This is because these are not placeholders, but Caddyfile-specific [environmenta
It is therefore important to understand that `{env.HOST}` is inherently different from something like `{$HOST}` It is therefore important to understand that `{env.HOST}` is inherently different from something like `{$HOST}`
As an example, see the following caddyfile: As an example, see the following caddyfile:
``` ```caddyfile
:8080 { :8080 {
respond {$HOST} 200 respond {$HOST} 200
} }
@ -32,7 +32,7 @@ As an example, see the following caddyfile:
``` ```
When you adapt this Caddyfile with `HOST=example caddy adapt` you will get When you adapt this Caddyfile with `HOST=example caddy adapt` you will get
``` ```json
{ {
"apps": { "apps": {
"http": { "http": {
@ -83,9 +83,9 @@ Since `srv1` used `{env.HOST}`, a standard placeholder, it was parsed as a norma
This means that down the line, the handler plugins will receive both `example` and `{env.Host}` respectively in their configurations. This means that down the line, the handler plugins will receive both `example` and `{env.Host}` respectively in their configurations.
## Using Placeholders in your Plugin ## How to Placeholders in your Plugin
#### How to parse Placeholders in your Unmarshaler #### Parse the raw Placeholder in your unmarshaler
Placeholders should be parsed as their raw values when parsing caddyfiles, just like any other string value Placeholders should be parsed as their raw values when parsing caddyfiles, just like any other string value
@ -99,7 +99,7 @@ func (g *Gizmo) UnmarshalCaddyfile(d *caddyfile.Dispenser) error {
} }
``` ```
#### How to resolve Placeholders during Serve or Match #### Resolve the Placeholder during Match or Serve
In order to now correctly read our `g.Name` placeholder, in a plugin matcher or middleware, we must extract the replacer from the context, and use that replacer on our saved placeholder string. In order to now correctly read our `g.Name` placeholder, in a plugin matcher or middleware, we must extract the replacer from the context, and use that replacer on our saved placeholder string.
@ -114,7 +114,7 @@ func (g *Gizmo) ServeHTTP(w http.ResponseWriter, r *http.Request, next caddyhttp
} }
``` ```
#### How to resolve Placeholders at Provision time #### Alternatively, resolve the Placeholder during Provision
If you only use global placeholders, like `env`, then you may initialize a global replacer at provision time, and use it to replace such values. If you only use global placeholders, like `env`, then you may initialize a global replacer at provision time, and use it to replace such values.