Skip to content

Commit

Permalink
chore: set required field for all auth examples (#274)
Browse files Browse the repository at this point in the history
Signed-off-by: Mark Phelps <[email protected]>
  • Loading branch information
markphelps authored Sep 20, 2024
1 parent eb77d15 commit 253ef42
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions configuration/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ In order to establish a browser session over HTTP (via a `Cookie` header) some c

```yaml config.yaml
authentication:
required: true
session:
domain: "flipt.yourorg.com"
secure: true
Expand Down Expand Up @@ -97,6 +98,7 @@ The `token` method provides the ability to create client tokens statically, with
```yaml config.yaml
authentication:
required: true
methods:
token:
enabled: true
Expand All @@ -123,6 +125,7 @@ Once enabled and configured, the UI will automatically leverage it and present a

```yaml config.yaml
authentication:
required: true
methods:
oidc:
enabled: true
Expand Down Expand Up @@ -237,6 +240,7 @@ We could create a provider definition in our configuration like so:

```yaml config.yaml
authentication:
required: true
methods:
oidc:
enabled: true
Expand Down Expand Up @@ -288,6 +292,7 @@ Once enabled and configured, the UI will automatically leverage it and present a

```yaml config.yaml
authentication:
required: true
methods:
github:
enabled: true
Expand All @@ -308,6 +313,7 @@ To enable this feature, set the `github.allowed_organizations` configuration val

```yaml config.yaml
authentication:
required: true
methods:
github:
enabled: true
Expand All @@ -331,6 +337,7 @@ To enable this feature, set the `github.allowed_teams` configuration value to a

```yaml config.yaml
authentication:
required: true
methods:
github:
enabled: true
Expand All @@ -357,6 +364,7 @@ The `kubernetes` method provides the ability to exchange Kubernetes service acco

```yaml config.yaml
authentication:
required: true
methods:
kubernetes:
enabled: true
Expand Down Expand Up @@ -391,6 +399,7 @@ The `flipt` distributed Docker image has valid and trusted certificates in `/etc

```yaml example-config-for-eks.yaml
authentication:
required: true
methods:
kubernetes:
enabled: true
Expand Down Expand Up @@ -430,6 +439,7 @@ The `jwks_url` configuration value is a URL that points to a JWKS (JSON Web Key

```yaml config.yaml
authentication:
required: true
methods:
jwt:
enabled: true
Expand All @@ -442,6 +452,7 @@ The `public_key_file` configuration value is the path to a PEM encoded public ke

```yaml config.yaml
authentication:
required: true
methods:
jwt:
enabled: true
Expand All @@ -465,6 +476,7 @@ To enable claim validation, configure the values in the `validate_claims` config

```yaml config.yaml
authentication:
required: true
methods:
jwt:
enabled: true
Expand All @@ -481,9 +493,11 @@ This object configures the periodic deletion of _expired_ authentications create

```yaml config.yaml
authentication:
<method>:
cleanup:
interval: 10m
required: true
methods:
<method>:
cleanup:
interval: 10m
grace_period: 24h
```

Expand Down

0 comments on commit 253ef42

Please sign in to comment.