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

chore: add read only force docs #152

Merged
merged 2 commits into from
Dec 6, 2023
Merged

chore: add read only force docs #152

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
023e84a
chore: add read only force docs
markphelps Dec 6, 2023
e96d62a
chore: format code
markphelps Dec 6, 2023
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
1 change: 1 addition & 0 deletions configuration/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,9 +201,10 @@

### Storage

| Property | Description | Default | Since |

Check failure on line 204 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / lint 

Insert `·····`
| ------------ | --------------------------------------------------------- | -------- | ------- |

Check failure on line 205 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / lint 

Insert `-----`
| storage.type | The type of storage to use (database, local, git, object) | database | v1.25.0 |

Check failure on line 206 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / lint 

Insert `·····`
| storage.read_only | Enable read-only mode for storage | false | v1.25.0 |

Check failure on line 207 in configuration/overview.mdx

View workflow job for this annotation

GitHub Actions / lint 

Replace `|·false` with `························|·false···`

#### Storage Local

Expand Down
4 changes: 4 additions & 0 deletions configuration/storage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,10 @@

Once enabled, all filesystem backends put the Flipt API and UI into a `read-only` mode that prevents Flipt from writing to the backend. This is useful for production environments where you want to ensure that flag state is only managed via the configured backend.

<Tip>
You can also put Flipt into `read-only` mode by setting the `FLIPT_STORAGE_READ_ONLY` environment variable to `true`, or setting `storage.read_only` to `true` in your configuration.

Check failure on line 133 in configuration/storage.mdx

View workflow job for this annotation

GitHub Actions / lint 

Replace `You·can·also·put·Flipt·into·`read-only`·mode·by·setting·the·`FLIPT_STORAGE_READ_ONLY`·environment·variable·to·`true`,·or·setting` with `··You·can·also·put·Flipt·into·`read-only`·mode·by·setting·the⏎··`FLIPT_STORAGE_READ_ONLY`·environment·variable·to·`true`,·or·setting⏎·`
</Tip>

### Local

The purpose of this backend type is to support serving Flipt flag state directly from your local filesystem.
Expand Down
Loading