Skip to content

docs: document Docker gomplate configuration#4759

Open
AkashKumar7902 wants to merge 1 commit intodexidp:masterfrom
AkashKumar7902:issue-2645-gomplate-docs
Open

docs: document Docker gomplate configuration#4759
AkashKumar7902 wants to merge 1 commit intodexidp:masterfrom
AkashKumar7902:issue-2645-gomplate-docs

Conversation

@AkashKumar7902
Copy link
Copy Markdown

@AkashKumar7902 AkashKumar7902 commented Apr 25, 2026

Overview

Closes #2645.

What this PR does / why we need it

  • Documents that the official container entrypoint renders .yaml, .tpl, and .tmpl config arguments with gomplate before starting dex.
  • Clarifies that this preprocessing is separate from dex's built-in $VAR config expansion.
  • Notes that the Kubernetes example overrides the image entrypoint, so it uses dex config expansion rather than gomplate.

Special notes for your reviewer

Validation:

  • go test ./cmd/docker-entrypoint -run TestRun -count=1
  • go test ./cmd/dex -run "TestUnmarshalConfigWithEnv(NoExpand|Expand)$" -count=1
  • git diff --check

Copy link
Copy Markdown
Member

@nabokihms nabokihms left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@AkashKumar7902, hello and thank you for submitting the PR!

The README file is not the place for this kind of a doc. Please consider moving it to https://dexidp.io/docs/configuration/

Signed-off-by: Akash Kumar <meakash7902@gmail.com>
@AkashKumar7902 AkashKumar7902 force-pushed the issue-2645-gomplate-docs branch from 1f1887c to 944ed70 Compare April 29, 2026 22:02
@AkashKumar7902
Copy link
Copy Markdown
Author

@nabokihms Thanks! You're right — I removed the README block. The PR now only adds a small inline comment in examples/k8s/dex.yaml explaining why gomplate doesn't apply when overriding the container command (which is a property of that specific example, not general doc).

I'll open a follow-up against the docs site to add the gomplate / DEX_EXPAND_ENV content under docs/configuration/. PTAL.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Include links and information for gomplate

2 participants