2022-12-23 10:58:54 +00:00
|
|
|
---
|
|
|
|
|
title: "Templating"
|
|
|
|
|
description: "A reference guide on the templates system"
|
|
|
|
|
lead: "This section contains reference documentation for Authelia's templating capabilities."
|
2023-01-03 15:03:23 +00:00
|
|
|
date: 2022-12-23T21:58:54+11:00
|
2022-12-23 10:58:54 +00:00
|
|
|
draft: false
|
|
|
|
|
images: []
|
|
|
|
|
menu:
|
|
|
|
|
reference:
|
|
|
|
|
parent: "guides"
|
|
|
|
|
weight: 220
|
|
|
|
|
toc: true
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
Authelia has several methods where users can interact with templates.
|
|
|
|
|
|
|
|
|
|
## Functions
|
|
|
|
|
|
|
|
|
|
Functions can be used to perform specific actions when executing templates. The following is a simple guide on which
|
|
|
|
|
functions exist.
|
|
|
|
|
|
|
|
|
|
### Standard Functions
|
|
|
|
|
|
|
|
|
|
Go has a set of standard functions which can be used. See the [Go Documentation](https://pkg.go.dev/text/template#hdr-Functions)
|
|
|
|
|
for more information.
|
|
|
|
|
|
|
|
|
|
### Helm-like Functions
|
|
|
|
|
|
|
|
|
|
The following functions which mimic the behaviour of helm exist in most templating areas:
|
|
|
|
|
|
|
|
|
|
- env
|
|
|
|
|
- expandenv
|
|
|
|
|
- split
|
|
|
|
|
- splitList
|
|
|
|
|
- join
|
|
|
|
|
- contains
|
|
|
|
|
- hasPrefix
|
|
|
|
|
- hasSuffix
|
|
|
|
|
- lower
|
|
|
|
|
- upper
|
|
|
|
|
- title
|
|
|
|
|
- trim
|
|
|
|
|
- trimAll
|
|
|
|
|
- trimSuffix
|
|
|
|
|
- trimPrefix
|
|
|
|
|
- replace
|
|
|
|
|
- quote
|
|
|
|
|
- sha1sum
|
|
|
|
|
- sha256sum
|
|
|
|
|
- sha512sum
|
|
|
|
|
- squote
|
|
|
|
|
- now
|
2022-12-27 08:59:08 +00:00
|
|
|
- keys
|
|
|
|
|
- sortAlpha
|
|
|
|
|
- b64enc
|
|
|
|
|
- b64dec
|
|
|
|
|
- b32enc
|
|
|
|
|
- b32dec
|
2023-01-03 03:49:02 +00:00
|
|
|
- list
|
|
|
|
|
- dict
|
|
|
|
|
- get
|
|
|
|
|
- set
|
|
|
|
|
- isAbs
|
|
|
|
|
- base
|
|
|
|
|
- dir
|
|
|
|
|
- ext
|
|
|
|
|
- clean
|
|
|
|
|
- osBase
|
|
|
|
|
- osClean
|
|
|
|
|
- osDir
|
|
|
|
|
- osExt
|
|
|
|
|
- osIsAbs
|
|
|
|
|
- deepEqual
|
|
|
|
|
- typeOf
|
|
|
|
|
- typeIs
|
|
|
|
|
- typeIsLike
|
|
|
|
|
- kindOf
|
|
|
|
|
- kindIs
|
2023-01-03 13:11:10 +00:00
|
|
|
- default
|
|
|
|
|
- empty
|
2023-02-07 14:28:09 +00:00
|
|
|
- indent
|
|
|
|
|
- nindent
|
|
|
|
|
- uuidv4
|
2023-04-08 04:48:55 +00:00
|
|
|
- urlquery
|
|
|
|
|
- urlunquery (opposite of urlquery)
|
2022-12-23 10:58:54 +00:00
|
|
|
|
|
|
|
|
See the [Helm Documentation](https://helm.sh/docs/chart_template_guide/function_list/) for more information. Please
|
2022-12-27 08:59:08 +00:00
|
|
|
note that only the functions listed above are supported and the functions don't necessarily behave exactly the same.
|
2022-12-23 10:58:54 +00:00
|
|
|
|
|
|
|
|
__*Special Note:* The `env` and `expandenv` function automatically excludes environment variables that start with
|
|
|
|
|
`AUTHELIA_` or `X_AUTHELIA_` and end with one of `KEY`, `SECRET`, `PASSWORD`, `TOKEN`, or `CERTIFICATE_CHAIN`.__
|
|
|
|
|
|
|
|
|
|
### Special Functions
|
|
|
|
|
|
|
|
|
|
The following is a list of special functions and their syntax.
|
|
|
|
|
|
|
|
|
|
#### iterate
|
|
|
|
|
|
|
|
|
|
Input is a single uint. Returns a slice of uints from 0 to the provided uint.
|
2023-02-07 14:28:09 +00:00
|
|
|
|
|
|
|
|
#### fileContent
|
|
|
|
|
|
|
|
|
|
Input is a path. Returns the content of a file.
|
