Skip to content

docs: add secret references for static token authentication #399

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

Merged
markphelps merged 2 commits into from
Feb 28, 2026
Merged

docs: add secret references for static token authentication #399

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f2a0b9b
docs: add secret references examples for static token authentication
github-actions[bot] Feb 27, 2026
7a69f98
docs: address review feedback on secret references examples
markphelps Feb 28, 2026
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
49 changes: 49 additions & 0 deletions docs/v2/configuration/authentication.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,55 @@ authentication:
some_key: "some_value"
```

#### Using Secret References

To avoid storing token values directly in your configuration file, you can use [secret references](/v2/configuration/overview#secret-references) with a configured [secret provider](/v2/configuration/secrets).

Using the [file provider](/v2/configuration/secrets#file-provider):

```yaml config.yaml
authentication:
required: true
methods:
token:
enabled: true
storage:
tokens:
"ci_token":
credential: "${secret:file:ci-token}" # References /etc/flipt/secrets/ci-token
metadata:
name: "CI Pipeline Token"
"dev_token":
credential: "${secret:file:dev-token}" # References /etc/flipt/secrets/dev-token
metadata:
name: "Development Token"
```

Using the [HashiCorp Vault provider](/v2/configuration/secrets#hashicorp-vault-provider):

```yaml config.yaml
authentication:
required: true
methods:
token:
enabled: true
storage:
tokens:
"ci_token":
credential: "${secret:vault:flipt/tokens:ci-token}" # References flipt/tokens secret, key: ci-token
metadata:
name: "CI Pipeline Token"
"dev_token":
credential: "${secret:vault:flipt/tokens:dev-token}" # References flipt/tokens secret, key: dev-token
metadata:
name: "Development Token"
```

<Tip>
See [Secrets](/v2/configuration/secrets) for details on configuring secret
providers.
</Tip>

### OIDC

<Note>The `OIDC` method is a `session compatible` authentication method.</Note>
Expand Down
29 changes: 22 additions & 7 deletions docs/v2/configuration/secrets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,28 +166,43 @@ Secret references use the format `${secret:provider:key}` where:

```yaml
server:
cert_file: ${secret:file:tls-cert} # References /etc/flipt/secrets/tls-cert
cert_key: ${secret:file:tls-key} # References /etc/flipt/secrets/tls-key
cert_file: "${secret:file:tls-cert}" # References /etc/flipt/secrets/tls-cert
cert_key: "${secret:file:tls-key}" # References /etc/flipt/secrets/tls-key

authentication:
required: true
session:
csrf:
key: ${secret:file:csrf-key} # References /etc/flipt/secrets/csrf-key
key: "${secret:file:csrf-key}" # References /etc/flipt/secrets/csrf-key
methods:
token:
enabled: true
storage:
tokens:
"ci_token":
credential: "${secret:file:ci-token}" # References /etc/flipt/secrets/ci-token
```

### Vault Provider Examples

```yaml
authentication:
required: true
methods:
oidc:
providers:
google:
client_id: ${secret:vault:auth/oidc:client_id}
client_secret: ${secret:vault:auth/oidc:client_secret}
client_id: "${secret:vault:auth/oidc:client_id}"
client_secret: "${secret:vault:auth/oidc:client_secret}"
github:
client_id: ${secret:vault:auth/github:client_id}
client_secret: ${secret:vault:auth/github:client_secret}
client_id: "${secret:vault:auth/github:client_id}"
client_secret: "${secret:vault:auth/github:client_secret}"
token:
enabled: true
storage:
tokens:
"ci_token":
credential: "${secret:vault:flipt/tokens:ci-token}"
```

### Combined with Environment Variables
Expand Down