Skip to content

Commit 48df392

Browse files
committed
docs: remove JSON file flag data source, no longer supported
Removes documentation for the flags.json file-based data source following bitwarden/server#7898 which dropped support for it.
1 parent b2be99e commit 48df392

1 file changed

Lines changed: 7 additions & 30 deletions

File tree

docs/contributing/feature-flags.md

Lines changed: 7 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -90,25 +90,25 @@ client development the flags are served from the Bitwarden API.
9090

9191
| Server configuration | Flag source |
9292
| -------------------- | ------------------------------------------------------------ |
93-
| Local development | Local application settings, JSON file, or code modification |
93+
| Local development | Local application settings or code modification |
9494
| Self-hosted | Flags are "off" unless above local configuration is provided |
9595
| QA Cloud | LaunchDarkly QA |
9696
| Production Cloud | LaunchDarkly Production |
9797

9898
:::caution Self-hosted support
9999

100-
Feature flags are not officially supported for self-hosted customers. Using application settings or
101-
a JSON file is not a supported method of sourcing feature flag values, outside of Bitwarden internal
102-
testing. See [Self-hosted considerations](#self-hosted-considerations) for how feature flagging
103-
applies to self-hosted.
100+
Feature flags are not officially supported for self-hosted customers. Using application settings is
101+
not a supported method of sourcing feature flag values, outside of Bitwarden internal testing. See
102+
[Self-hosted considerations](#self-hosted-considerations) for how feature flagging applies to
103+
self-hosted.
104104

105105
:::
106106

107107
Local development server instances will not query LaunchDarkly for feature flag values.
108108

109109
If you need to change any feature flag values from their defaults during local development, you will
110-
need to set up either local application settings or a file-based data source. **Without the local
111-
data store, all flag values will resolve as their default ("off") value.**
110+
need to set up local application settings. **Without the local data store, all flag values will
111+
resolve as their default ("off") value.**
112112

113113
### Local configuration: user secrets
114114

@@ -135,29 +135,6 @@ Remember to run `dev/setup_secrets.ps1` and restart your server for the new secr
135135

136136
Environment variables can also be used like with other application setting overrides.
137137

138-
### Local configuration: JSON file
139-
140-
To set up a data source via a local file, create a `flags.json` file as follows:
141-
142-
```json
143-
{
144-
"flagValues": {
145-
"example-boolean-key": true,
146-
"example-string-key": "value"
147-
}
148-
}
149-
```
150-
151-
Replace `example-boolean-key` and `example-string-key` with your flag names and update the flag
152-
values accordingly.
153-
154-
By default, the LaunchDarkly startup will look for this file in the root project directory (e.g.
155-
`/src/Api/` for the `Api` project), where it will be deployed to the build output directory.
156-
However, if you prefer to store the file in a different location, the `FlagDataFilePath`
157-
configuration setting can be used to override it. The file must be present before building the
158-
solution, but once there you can change the file contents and see immediate results in running /
159-
debugging code.
160-
161138
### Local configuration: code modification
162139

163140
In some situations there may be a need to change a feature flag value to be something other than its

0 commit comments

Comments
 (0)