From 442b25899eff3408a6079a8a820b89340590bcde Mon Sep 17 00:00:00 2001 From: "claude[bot]" <209825114+claude[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 12:11:23 +0000 Subject: [PATCH 1/2] docs: fix Docker config paths for v2 documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Correct config mount path from /etc/flipt/config.yaml to /etc/flipt/config/default.yml - Add comprehensive persistent storage documentation with full configuration example - Update login-with-github guide to use correct mount paths and include persistent storage - Ensure consistency across all v2 Docker examples Fixes #371 🤖 Generated with [Claude Code](https://claude.ai/code) Co-authored-by: Mark Phelps --- .../authentication/login-with-github.mdx | 8 +++++--- docs/v2/installation.mdx | 20 +++++++++++++++++-- 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/docs/v2/guides/operations/authentication/login-with-github.mdx b/docs/v2/guides/operations/authentication/login-with-github.mdx index df36e9c..6b49b84 100644 --- a/docs/v2/guides/operations/authentication/login-with-github.mdx +++ b/docs/v2/guides/operations/authentication/login-with-github.mdx @@ -78,11 +78,13 @@ The last bit of configuration is the session details. In order for the browser t ```bash docker run -it --rm \ -p 8080:8080 \ - -v "$(pwd)/config.yml:/config.yml" \ - flipt/flipt:v2 ./flipt server --config /config.yml + -p 9000:9000 \ + -v $HOME/flipt:/var/opt/flipt \ + -v "$(pwd)/config.yml:/etc/flipt/config/default.yml" \ + docker.flipt.io/flipt/flipt:v2 ``` -This will mount the `config.yml` as a volume in the container, and Flipt will use that configuration as it's provided as a command line flag option. +This will mount both the data directory for persistent storage and the `config.yml` configuration file into the container at the standard location. ### 3. Navigate to the Flipt UI diff --git a/docs/v2/installation.mdx b/docs/v2/installation.mdx index 241046a..6fd0593 100644 --- a/docs/v2/installation.mdx +++ b/docs/v2/installation.mdx @@ -103,17 +103,33 @@ application. ### Configuration -A default configuration file is included within the image. To supply a custom configuration, update the `docker run` command to mount your local configuration into the container: +A default configuration file is included within the image. To supply a custom configuration, update the `docker run` command to mount your local configuration into the container. + +The example below shows how to configure Flipt v2 with both persistent storage and a custom configuration file: ```console docker run -d \ -p 8080:8080 \ -p 9000:9000 \ -v $HOME/flipt:/var/opt/flipt \ - -v $HOME/flipt/config.yaml:/etc/flipt/config.yaml \ + -v $HOME/flipt/config.yaml:/etc/flipt/config/default.yml \ docker.flipt.io/flipt/flipt:v2 ``` +In this configuration: +- `$HOME/flipt:/var/opt/flipt` mounts the host directory for persistent data storage +- `$HOME/flipt/config.yaml:/etc/flipt/config/default.yml` mounts your custom configuration file + +Your `config.yaml` should specify the full path for storage: + +```yaml +storage: + default: + backend: + type: local + path: /var/opt/flipt +``` + ## Homebrew You can install Flipt v2 using [Homebrew](https://brew.sh/) on macOS and Linux. From bba018b63c82a3b9ec2ebe5f8b854481061abb35 Mon Sep 17 00:00:00 2001 From: "claude[bot]" <209825114+claude[bot]@users.noreply.github.com> Date: Fri, 3 Oct 2025 12:32:49 +0000 Subject: [PATCH 2/2] chore: format files according to CLAUDE.md guidelines Applied Prettier formatting to installation.mdx and Vale style files Co-authored-by: Mark Phelps --- docs/.vale/styles/Microsoft/HeadingAcronyms.yml | 2 +- docs/.vale/styles/Microsoft/Headings.yml | 2 +- docs/.vale/styles/Microsoft/Quotes.yml | 2 +- docs/.vale/styles/Microsoft/Semicolon.yml | 2 +- docs/.vale/styles/Microsoft/SentenceLength.yml | 1 - docs/.vale/styles/Microsoft/Spacing.yml | 4 ++-- docs/.vale/styles/Microsoft/Units.yml | 8 ++++---- docs/.vale/styles/Microsoft/Vocab.yml | 2 +- docs/v2/installation.mdx | 1 + 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/.vale/styles/Microsoft/HeadingAcronyms.yml b/docs/.vale/styles/Microsoft/HeadingAcronyms.yml index 9dc3b6c..efd5e3d 100644 --- a/docs/.vale/styles/Microsoft/HeadingAcronyms.yml +++ b/docs/.vale/styles/Microsoft/HeadingAcronyms.yml @@ -4,4 +4,4 @@ link: https://docs.microsoft.com/en-us/style-guide/acronyms#be-careful-with-acro level: warning scope: heading tokens: - - '[A-Z]{2,4}' + - "[A-Z]{2,4}" diff --git a/docs/.vale/styles/Microsoft/Headings.yml b/docs/.vale/styles/Microsoft/Headings.yml index 63624ed..abf3b53 100644 --- a/docs/.vale/styles/Microsoft/Headings.yml +++ b/docs/.vale/styles/Microsoft/Headings.yml @@ -5,7 +5,7 @@ level: suggestion scope: heading match: $sentence indicators: - - ':' + - ":" exceptions: - Azure - CLI diff --git a/docs/.vale/styles/Microsoft/Quotes.yml b/docs/.vale/styles/Microsoft/Quotes.yml index 38f4976..37fb92a 100644 --- a/docs/.vale/styles/Microsoft/Quotes.yml +++ b/docs/.vale/styles/Microsoft/Quotes.yml @@ -1,5 +1,5 @@ extends: existence -message: 'Punctuation should be inside the quotes.' +message: "Punctuation should be inside the quotes." link: https://docs.microsoft.com/en-us/style-guide/punctuation/quotation-marks level: error nonword: true diff --git a/docs/.vale/styles/Microsoft/Semicolon.yml b/docs/.vale/styles/Microsoft/Semicolon.yml index 4d90546..c6526ff 100644 --- a/docs/.vale/styles/Microsoft/Semicolon.yml +++ b/docs/.vale/styles/Microsoft/Semicolon.yml @@ -5,4 +5,4 @@ nonword: true scope: sentence level: suggestion tokens: - - ';' + - ";" diff --git a/docs/.vale/styles/Microsoft/SentenceLength.yml b/docs/.vale/styles/Microsoft/SentenceLength.yml index f248cf0..82e2656 100644 --- a/docs/.vale/styles/Microsoft/SentenceLength.yml +++ b/docs/.vale/styles/Microsoft/SentenceLength.yml @@ -4,4 +4,3 @@ scope: sentence level: suggestion max: 30 token: \b(\w+)\b - diff --git a/docs/.vale/styles/Microsoft/Spacing.yml b/docs/.vale/styles/Microsoft/Spacing.yml index bbd10e5..c8b5236 100644 --- a/docs/.vale/styles/Microsoft/Spacing.yml +++ b/docs/.vale/styles/Microsoft/Spacing.yml @@ -4,5 +4,5 @@ link: https://docs.microsoft.com/en-us/style-guide/punctuation/periods level: error nonword: true tokens: - - '[a-z][.?!] {2,}[A-Z]' - - '[a-z][.?!][A-Z]' + - "[a-z][.?!] {2,}[A-Z]" + - "[a-z][.?!][A-Z]" diff --git a/docs/.vale/styles/Microsoft/Units.yml b/docs/.vale/styles/Microsoft/Units.yml index f062418..4e3d71e 100644 --- a/docs/.vale/styles/Microsoft/Units.yml +++ b/docs/.vale/styles/Microsoft/Units.yml @@ -5,10 +5,10 @@ level: error raw: - '[a-zA-Z]+\s' tokens: - - '(?:centi|milli)?meters' - - '(?:kilo)?grams' - - '(?:kilo)?meters' - - '(?:mega)?pixels' + - "(?:centi|milli)?meters" + - "(?:kilo)?grams" + - "(?:kilo)?meters" + - "(?:mega)?pixels" - cm - inches - lb diff --git a/docs/.vale/styles/Microsoft/Vocab.yml b/docs/.vale/styles/Microsoft/Vocab.yml index eebe97b..73b5cd1 100644 --- a/docs/.vale/styles/Microsoft/Vocab.yml +++ b/docs/.vale/styles/Microsoft/Vocab.yml @@ -1,6 +1,6 @@ extends: existence message: "Verify your use of '%s' with the A-Z word list." -link: 'https://docs.microsoft.com/en-us/style-guide' +link: "https://docs.microsoft.com/en-us/style-guide" level: suggestion ignorecase: true tokens: diff --git a/docs/v2/installation.mdx b/docs/v2/installation.mdx index 6fd0593..b43c3bd 100644 --- a/docs/v2/installation.mdx +++ b/docs/v2/installation.mdx @@ -117,6 +117,7 @@ docker run -d \ ``` In this configuration: + - `$HOME/flipt:/var/opt/flipt` mounts the host directory for persistent data storage - `$HOME/flipt/config.yaml:/etc/flipt/config/default.yml` mounts your custom configuration file