mirror of
https://github.com/caddyserver/website.git
synced 2025-04-25 22:46:16 -04:00
docs: More changes for upcoming v2.5.0 release (#226)
This commit is contained in:
parent
35a02d78d7
commit
eaf0aae816
6 changed files with 73 additions and 8 deletions
53
src/docs/markdown/caddyfile/directives/vars.md
Normal file
53
src/docs/markdown/caddyfile/directives/vars.md
Normal file
|
@ -0,0 +1,53 @@
|
|||
---
|
||||
title: vars (Caddyfile directive)
|
||||
---
|
||||
|
||||
# vars
|
||||
|
||||
Sets one or more variables to a particular value, to be used later in the request handling chain.
|
||||
|
||||
The primary way to access variables is with placeholders, which have the form `{vars.variable_name}`, or with the [`vars`](/docs/caddyfile/matchers#vars) and [`vars_regexp`](/docs/caddyfile/matchers#vars_regexp) request matchers.
|
||||
|
||||
## Syntax
|
||||
|
||||
```caddy-d
|
||||
vars [<matcher>] [<name> <value>] {
|
||||
<name> <value>
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
- **<name>** is the variable name to set.
|
||||
|
||||
- **<value>** is the value of the variable.
|
||||
|
||||
The value will be type converted if possible; `true` and `false` will be converted to boolean types, and numeric values will be converted to integer or float accordingly. To avoid this conversion, you may wrap the output with [quotes](/docs/caddyfile/concepts#tokens-and-quotes) and they will stay strings.
|
||||
|
||||
## Examples
|
||||
|
||||
To set a single variable, the value being conditional based on the request path, then responding with the value:
|
||||
|
||||
```caddy-d
|
||||
vars /foo* isFoo "yep"
|
||||
vars isFoo "nope"
|
||||
|
||||
respond {vars.isFoo}
|
||||
```
|
||||
|
||||
To set multiple variables, each converted to the appropriate scalar type:
|
||||
|
||||
```caddy-d
|
||||
vars {
|
||||
# boolean
|
||||
abc true
|
||||
|
||||
# integer
|
||||
def 1
|
||||
|
||||
# float
|
||||
ghi 2.3
|
||||
|
||||
# string
|
||||
jkl "example"
|
||||
}
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue