From 11063e08ce6eafa661aaf3204059498753d88339 Mon Sep 17 00:00:00 2001 From: Mark Phelps <209477+markphelps@users.noreply.github.com> Date: Wed, 6 Dec 2023 10:01:10 -0500 Subject: [PATCH] chore: add read only force docs (#152) * chore: add read only force docs * chore: format code --------- Co-authored-by: markphelps --- configuration/overview.mdx | 7 ++++--- configuration/storage.mdx | 6 ++++++ 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/configuration/overview.mdx b/configuration/overview.mdx index 0c503be..0b66112 100644 --- a/configuration/overview.mdx +++ b/configuration/overview.mdx @@ -201,9 +201,10 @@ export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001" ### Storage -| Property | Description | Default | Since | -| ------------ | --------------------------------------------------------- | -------- | ------- | -| storage.type | The type of storage to use (database, local, git, object) | database | v1.25.0 | +| Property | Description | Default | Since | +| ----------------- | --------------------------------------------------------- | -------- | ------- | +| storage.type | The type of storage to use (database, local, git, object) | database | v1.25.0 | +| storage.read_only | Enable read-only mode for storage | false | v1.25.0 | #### Storage Local diff --git a/configuration/storage.mdx b/configuration/storage.mdx index 678506f..af2d8dc 100644 --- a/configuration/storage.mdx +++ b/configuration/storage.mdx @@ -129,6 +129,12 @@ whereas, the `git`, `object` and `oci` backends are intended for production use. 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. + + 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. + + ### Local The purpose of this backend type is to support serving Flipt flag state directly from your local filesystem.