Skip to content

Commit 442b258

Browse files
docs: fix Docker config paths for v2 documentation
- 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 <[email protected]>
1 parent 7a44118 commit 442b258

File tree

2 files changed

+23
-5
lines changed

2 files changed

+23
-5
lines changed

docs/v2/guides/operations/authentication/login-with-github.mdx

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,13 @@ The last bit of configuration is the session details. In order for the browser t
7878
```bash
7979
docker run -it --rm \
8080
-p 8080:8080 \
81-
-v "$(pwd)/config.yml:/config.yml" \
82-
flipt/flipt:v2 ./flipt server --config /config.yml
81+
-p 9000:9000 \
82+
-v $HOME/flipt:/var/opt/flipt \
83+
-v "$(pwd)/config.yml:/etc/flipt/config/default.yml" \
84+
docker.flipt.io/flipt/flipt:v2
8385
```
8486

85-
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.
87+
This will mount both the data directory for persistent storage and the `config.yml` configuration file into the container at the standard location.
8688

8789
### 3. Navigate to the Flipt UI
8890

docs/v2/installation.mdx

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,17 +103,33 @@ application.
103103

104104
### Configuration
105105

106-
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:
106+
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.
107+
108+
The example below shows how to configure Flipt v2 with both persistent storage and a custom configuration file:
107109

108110
```console
109111
docker run -d \
110112
-p 8080:8080 \
111113
-p 9000:9000 \
112114
-v $HOME/flipt:/var/opt/flipt \
113-
-v $HOME/flipt/config.yaml:/etc/flipt/config.yaml \
115+
-v $HOME/flipt/config.yaml:/etc/flipt/config/default.yml \
114116
docker.flipt.io/flipt/flipt:v2
115117
```
116118

119+
In this configuration:
120+
- `$HOME/flipt:/var/opt/flipt` mounts the host directory for persistent data storage
121+
- `$HOME/flipt/config.yaml:/etc/flipt/config/default.yml` mounts your custom configuration file
122+
123+
Your `config.yaml` should specify the full path for storage:
124+
125+
```yaml
126+
storage:
127+
default:
128+
backend:
129+
type: local
130+
path: /var/opt/flipt
131+
```
132+
117133
## Homebrew
118134
119135
You can install Flipt v2 using [Homebrew](https://brew.sh/) on macOS and Linux.

0 commit comments

Comments
 (0)