Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/.vale/styles/Microsoft/HeadingAcronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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}"
2 changes: 1 addition & 1 deletion docs/.vale/styles/Microsoft/Headings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ level: suggestion
scope: heading
match: $sentence
indicators:
- ':'
- ":"
exceptions:
- Azure
- CLI
Expand Down
2 changes: 1 addition & 1 deletion docs/.vale/styles/Microsoft/Quotes.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/.vale/styles/Microsoft/Semicolon.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ nonword: true
scope: sentence
level: suggestion
tokens:
- ';'
- ";"
1 change: 0 additions & 1 deletion docs/.vale/styles/Microsoft/SentenceLength.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,3 @@ scope: sentence
level: suggestion
max: 30
token: \b(\w+)\b

4 changes: 2 additions & 2 deletions docs/.vale/styles/Microsoft/Spacing.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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]"
8 changes: 4 additions & 4 deletions docs/.vale/styles/Microsoft/Units.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/.vale/styles/Microsoft/Vocab.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
21 changes: 19 additions & 2 deletions docs/v2/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,17 +103,34 @@ 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.
Expand Down
Loading