Skip to content

docs: clarify config environment expansion #213

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

Open
AkashKumar7902 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify config environment expansion #213

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 11 additions & 1 deletion content/docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The [example config][example-config] file documents many of the configuration op

### Templated configuration

The default entrypoint for distributed container images utilize [gomplate][gomplate]
The default entrypoint for distributed container images utilizes [gomplate][gomplate]
to pre-process configuration files (`.tpl`, `.tmpl`, `.yaml`) passed as arguments.
This enables templating any field from the environment, for example:

Expand All @@ -53,6 +53,16 @@ secret: "{{ .Env.MY_SECRET_ENV }}"

See [gomplate docs][gomplate-docs] for templating syntax.

Gomplate preprocessing is provided by the container image entrypoint. If a
deployment overrides the container command and runs the `dex` binary directly,
for example `dex serve /etc/dex/config.yaml`, the entrypoint is skipped and
gomplate templates are not rendered.

Dex also expands environment variables in configuration values before parsing
the config file. This supports `$VAR` and `${VAR}` references in YAML values,
such as connector credentials. Set `DEX_EXPAND_ENV=false` to disable this
built-in expansion.

## Running a client

Dex operates like most other OAuth2 providers. Users are redirected from a client app to dex to login. Dex ships with an example client app (built with the `make examples` command), for testing and demos.
Expand Down