diff options
| author | Matthew Holt <mholt@users.noreply.github.com> | 2020-04-24 21:05:09 -0600 |
|---|---|---|
| committer | Matthew Holt <mholt@users.noreply.github.com> | 2020-04-24 21:05:09 -0600 |
| commit | 02845bc9fdc3e9189d44f3bd30e8609cd59c97dd (patch) | |
| tree | 798d7433a9c30615d3c3316d22f82174dc0f6a81 /modules/caddyhttp/templates | |
| parent | 97ed9e111d04718583c8e0cd141a464c993e224a (diff) | |
docs: Improve template documentation slightly; use const, not literal
Diffstat (limited to 'modules/caddyhttp/templates')
| -rw-r--r-- | modules/caddyhttp/templates/templates.go | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/modules/caddyhttp/templates/templates.go b/modules/caddyhttp/templates/templates.go index d67b35b..f5df9be 100644 --- a/modules/caddyhttp/templates/templates.go +++ b/modules/caddyhttp/templates/templates.go @@ -113,6 +113,19 @@ func init() { // {{.RemoteIP}} // ``` // +// ##### `.Req` +// +// Accesses the current HTTP request, which has various fields, including: +// +// - `.Method` - the method +// - `.URL` - the URL, which in turn has component fields (Scheme, Host, Path, etc.) +// - `.Header` - the header fields +// - `.Host` - the Host or :authority header of the request +// +// ``` +// {{.Req.Header.Get "User-Agent"}} +// ``` +// // ##### `.RespHeader.Add` // // Adds a header field to the HTTP response. |