Skip to content
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

Jump to bottom

chore: document env substitution #242

Merged
merged 1 commit into from
Jun 26, 2024
Merged

chore: document env substitution #242

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
21 changes: 21 additions & 0 deletions configuration/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,27 @@
You can edit any of these properties to your liking, and on restart Flipt will
pick up the new changes.

### Environment Substitution

Check warning on line 43 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.Titles] 'Environment Substitution' should be in sentence case

Raw Output:
{"message": "[Openly.Titles] 'Environment Substitution' should be in sentence case", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 43, "column": 5}}}, "severity": "WARNING"}

The configuration file also supports environment variable substitution as of `v1.45.0`.

Check warning on line 45 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.So] Don't start a sentence with 'so '

Raw Output:
{"message": "[Openly.So] Don't start a sentence with 'so '", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 45, "column": 26}}}, "severity": "WARNING"}

This allows you to use environment variables in your configuration file. For example, you can use the `FLIPT_CUSTOM_DB_URL` environment variable in the configuration file like this:

```yaml
db:
url: ${FLIPT_CUSTOM_DB_URL}
```

This will replace `${FLIPT_CUSTOM_DB_URL}` with the value of the `FLIPT_CUSTOM_DB_URL` environment variable. The format for environment variable substitution is `${ENV_VAR}`.

Check warning on line 54 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.FutureTense] Possible future tense.

Raw Output:
{"message": "[Openly.FutureTense] Possible future tense.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 54, "column": 6}}}, "severity": "WARNING"}

<Tip>
This can be used to provide sensitive information to Flipt without storing it
in the configuration file. For example, you can use environment variables to

Check warning on line 58 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Openly.SentenceLength] Write short sentences (less than 25 words).

Raw Output:
{"message": "[Openly.SentenceLength] Write short sentences (less than 25 words).", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 58, "column": 30}}}, "severity": "WARNING"}
store the database URL, API keys, or other sensitive information without

Check warning on line 59 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / Vale 

[vale] reported by reviewdog 🐶
[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.

Raw Output:
{"message": "[Microsoft.GeneralURL] For a general audience, use 'address' rather than 'URL'.", "location": {"path": "configuration/overview.mdx", "range": {"start": {"line": 59, "column": 22}}}, "severity": "WARNING"}
having to conform to the pre-defined Flipt [environment variable
format](#environment-variables).
</Tip>

### Remote Configuration

Flipt supports fetching configuration from a remote source. This is useful for managing configuration across multiple instances of Flipt. The remote configuration source can be a URL to a configuration file stored in one of the following object storage services:
Expand Down
Loading