Overview

Configuration precedence is as follows:

1. Environment Variables
2. Configuration File

​

Configuration File

The default way that Flipt is configured is with the use of a configuration file default.yml.

This file is read when Flipt starts up and configures several important properties for the server.

The server will check in a few different locations for server configuration (in order):

1. --config flag as an override
2. {{ USER_CONFIG_DIR }}/flipt/config.yml (the USER_CONFIG_DIR value is based on your architecture and specified in the Go documentation)
3. /etc/flipt/config/default.yml

You can edit any of these properties to your liking, and on restart, Flipt will pick up the new changes.

​

Environment Substitution

The configuration file also supports environment variable substitution.

This allows you to use environment variables in your configuration file. For example, you can use the FLIPT_CUSTOM_AUTH_REQUIRED environment variable in the configuration file like this:

authentication:
  required: ${FLIPT_CUSTOM_AUTH_REQUIRED}

This will replace ${FLIPT_CUSTOM_AUTH_REQUIRED} with the value of the FLIPT_CUSTOM_AUTH_REQUIRED environment variable. The format for environment variable substitution is ${ENV_VAR}.

​

Remote Configuration

Flipt supports fetching configuration from a remote source. This is useful for managing configuration across multiple instances of Flipt. The remote configuration source can be a URL to a configuration file stored in one of the following object storage services:

• S3 (e.g.: s3://bucket-name/path/to/config.yml)
• Azure Blob Storage (e.g.: azblob://container-name/path/to/config.yml)
• Google Cloud Storage (e.g.: googlecloud://bucket-name/path/to/config.yml)

To load Flipt configuration from a remote source, replace the config.yml file with the URL to the remote configuration file in the --config flag when starting the server.

flipt server --config s3://bucket-name/path/to/config.yml

For authenticating with the object storage service, you can use the following environment variables depending on the service:

• AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY
• AZURE_STORAGE_ACCOUNT and AZURE_STORAGE_KEY or AZURE_CLIENT_ID, AZURE_TENANT_ID, and AZURE_CLIENT_SECRET
• GOOGLE_APPLICATION_CREDENTIALS

​

Environment Variables

All options in the configuration file can be overridden using environment variables using the syntax:

FLIPT_<SectionName>_<KeyName>

Environment variables MUST have FLIPT_ prefix and be in UPPER_SNAKE_CASE format.

Keys should be uppercase and . should be replaced by _. For example, given these configuration settings:

server:
  grpc_port: 9000

You can override them using:

export FLIPT_SERVER_GRPC_PORT=9001

​

Multiple Values

Some configuration options can have a list of values. For example, the cors.allowed_origins option can have multiple origins.

In this case, you can use a space separated list of values for the environment variable override:

export FLIPT_CORS_ALLOWED_ORIGINS="http://localhost:3000 http://localhost:3001"

​

Configuration Parameters

​

User Interface

​

Server

​

Environments

​

Storage

​

Credentials

​

Authentication

​

Authentication Session

​

Authentication Session Storage

​

Authentication Session Storage: Redis

​

Authentication Methods: Static Token

​

Authentication Methods: OIDC

​

Authentication Methods: GitHub

​

Authentication Methods: Kubernetes

​

Authentication Methods: JWT

​

Authorization

​

Authorization Backend: Local

​

Analytics

​

Analytics: Clickhouse

​

Analytics: Prometheus

​

Logging

​

Logging: OTLP

Flipt v2 supports the new OpenTelemetry OTLP logging specification. To enable OTLP logging, set the OTLP_LOGS_EXPORTER environment variable

export OTLP_LOGS_EXPORTER=otlp

OpenTelemetry OTLP logging is configured via the default OpenTelemetry Environment Variables. See the OpenTelemetry Environment Variables documentation for more details.

For example, to configure the OTLP logging endpoint, you can set the OTEL_EXPORTER_OTLP_LOGS_ENDPOINT environment variable.

export OTEL_EXPORTER_OTLP_LOGS_ENDPOINT=http://localhost:4317

​

Metrics

​

Metrics: OTLP

OpenTelemetry OTLP metrics are configured via the default OpenTelemetry Environment Variables. See the OpenTelemetry Environment Variables documentation for more details.

For example, to configure the OTLP metrics endpoint, you can set the OTEL_EXPORTER_OTLP_METRICS_ENDPOINT environment variable.

export OTEL_EXPORTER_OTLP_METRICS_ENDPOINT=http://localhost:4317

To configure the OTLP headers, you can set the OTEL_EXPORTER_OTLP_METRICS_HEADERS environment variable.

export OTEL_EXPORTER_OTLP_METRICS_HEADERS="Authorization=Bearer <token>"

​

Tracing

​

Tracing: OTLP

OpenTelemetry OTLP tracing is configured via the default OpenTelemetry Environment Variables. See the OpenTelemetry Environment Variables documentation for more details.

For example, to configure the OTLP tracing endpoint, you can set the OTEL_EXPORTER_OTLP_TRACES_ENDPOINT environment variable.

export OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:4317

To configure the OTLP headers, you can set the OTEL_EXPORTER_OTLP_TRACES_HEADERS environment variable.

export OTEL_EXPORTER_OTLP_TRACES_HEADERS="Authorization=Bearer <token>"

​

Deprecations

From time to time configuration options will need to be deprecated and eventually removed. Deprecated configuration options will be removed after ~6 months from the time they were deprecated.

All deprecated configuration options will be removed from the documentation, however, they will still work as expected until they’re removed. A warning will be logged in the Flipt logs when a deprecated configuration option is used.

All deprecated options are listed in the DEPRECATIONS file in the Flipt repository as well as the CHANGELOG.