flipt

<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=dc285028-90ba-436b-9a4a-e0d826a2c986" alt="" /> <p align=center> <img src="logo.svg" alt="Flipt" width=275 height=96 /> </p> <p align="center">An enterprise-ready, GRPC powered, GitOps enabled, CloudNative, feature management solution</p> <hr /> <p align="center"> <img src=".github/images/dashboard.png" alt="Flipt Dashboard" width=600 /> </p> <br clear="both"/> <div align="center"> <a href="https://github.com/flipt-io/flipt/releases"> <img src="https://img.shields.io/github/release/flipt-io/flipt.svg?style=flat" alt="Releases" /> </a> <a href="https://github.com/flipt-io/flipt/blob/main/LICENSE"> <img src="https://img.shields.io/github/license/flipt-io/flipt.svg" alt="GPL 3.0" /> </a> <a href="https://codecov.io/gh/flipt-io/flipt"> <img src="https://codecov.io/gh/flipt-io/flipt/branch/main/graph/badge.svg" alt="Coverage" /> </a> <a href="https://goreportcard.com/report/github.com/flipt-io/flipt"> <img src="https://goreportcard.com/badge/github.com/flipt-io/flipt" alt="Go Report Card" /> </a> <a href="https://github.com/avelino/awesome-go"> <img src="https://awesome.re/mentioned-badge.svg" alt="Mentioned in Awesome Go" /> </a> <a href="https://flipt.io/discord"> <img alt="Discord" src="https://img.shields.io/discord/960634591000014878?color=%238440f1&label=Discord&logo=discord&logoColor=%238440f1&style=flat" /> </a> <a href="https://github.com/orgs/flipt-io/projects/4"> <img src="https://img.shields.io/badge/roadmap-public-violet" alt="Public Roadmap" /> </a> <a href="https://flipt.io/#newsletter"> <img src="https://img.shields.io/badge/newsletter-subscribe-green" alt="Flipt Newsletter" /> </a> <a href="https://twitter.com/flipt_io"> <img src="https://img.shields.io/twitter/follow/flipt_io?label=Follow" alt="Flipt Twitter" /> </a> </div> <div align="center"> <h4> <a href="https://www.flipt.io/docs/introduction">Docs</a> • <a href="http://www.flipt.io">Website</a> • <a href="http://www.flipt.io/blog">Blog</a> • <a href="https://features.flipt.io/">Feedback</a> • <a href="#contributing">Contributing</a> • <a href="https://www.flipt.io/discord">Discord</a> </h4> </div>

Flipt enables you to follow DevOps best practices and separate releases from deployments. Built with high-performance engineering organizations in mind.

Flipt can be deployed within your existing infrastructure so that you don't have to worry about your information being sent to a third party or the latency required to communicate across the internet.

With our GitOps-friendly functionality, you can easily integrate Flipt into your CI/CD workflows to enable continuous configuration and deployment with confidence.

<br clear="both"/> <p align="center"> <a href="https://devhunt.org/tool/flipt" title="DevHunt - Tool of the Week"><img src="./.github/images/devhunt-badge.png" width=225 alt="DevHunt - Tool of the Week" /></a>&nbsp; <a href="https://console.dev/tools/flipt" title="Visit Console - the best tools for developers"><img src="./.github/images/console-badge.png" width=250 alt="Console - Developer Tool of the Week" /></a> </p>

Managed Services

Need more? We've got you covered! Check out our managed offering.

<p align="center"> <a href="https://flipt.io/cloud" title="Flipt Hybrid Cloud"> <img src="./.github/images/flipt-cloud.svg" alt="Flipt Hybrid Cloud" /> </a> </p>

Usecases

Flipt supports use cases such as:

• Enabling trunk-based development workflows
• Testing new features internally during development before releasing them fully in production
• Ensuring overall system safety by guarding new releases with an emergency kill switch
• Gating certain features for different permission levels allows you to control who sees what
• Enabling continuous configuration by changing values during runtime without additional deployments

<br clear="both"/>

Values

• 🔒 Security - HTTPS, OIDC, JWT, OAuth, K8s Service Token, and API Token authentication methods supported out of the box.
• 🎛️ Control - No data leaves your servers and you don't have to open your systems to the outside world to communicate with Flipt. It all runs within your existing infrastructure.
• 🚀 Speed - Since Flipt is co-located with your existing services, you do not have to communicate across the internet which can add excessive latency and slow down your applications.
• ✅ Simplicity - Flipt is a single binary with no external dependencies by default.
• 👍 Compatibility - GRPC, REST, MySQL, Postgres, CockroachDB, SQLite, LibSQL, Redis, ClickHouse... Flipt supports it all.

<br clear="both"/>

Features

• Stand-alone, single binary that's easy to run and configure
• Ability to create advanced distribution rules to target segments of users
• Modern UI and debug console with dark mode 🌙
• Import and export to allow storing your data as code
• Works with Prometheus and OpenTelemetry out of the box 🔋
• CloudNative Filesystem, Object, Git, and OCI declarative storage backends to support GitOps workflows and more.
• Audit logging with Webhook support to track changes to your data

Are we missing a feature that you'd like to see? Let us know!

<br clear="both"/>

Contributing

We would love your help! Before submitting a PR, please read over the Contributing guide.

No contribution is too small, whether it be bug reports/fixes, feature requests, documentation updates, or anything else that can help drive the project forward.

Check out our public roadmap to see what we're working on and where you can help.

Not sure how to get started? You can:

• Book a pairing session/code walkthrough with one of our teammates!

• Join our Discord, and ask any questions there

• Dive into any of the open issues, here are some examples:

  • Good First Issues
  • Backend
  • Frontend

• Looking for issues by effort? We've got you covered:

  • XS
  • Small
  • Medium
  • Large
  • XL

Review the Architecture and Development documentation for more information on how Flipt works.

<br clear="both"/>

Community

For help and discussion around Flipt, feature flag best practices, and more, join us on Discord.

<br clear="both"/>

Try It

Get started in seconds. Try the latest version of Flipt for yourself.

Local

curl -fsSL https://get.flipt.io/install | sh

Deploy

<div> <a href="https://marketplace.digitalocean.com/apps/flipt" alt="Deploy to DigitalOcean"> <img width="200" alt="Deploy to DigitalOcean" src="https://www.deploytodo.com/do-btn-blue.svg"/> </a>&nbsp; <a href="https://render.com/deploy" alt="Deploy to Render"> <img width="150" alt="Deploy to Render" src="http://render.com/images/deploy-to-render-button.svg" /> </a>&nbsp; <a href="https://railway.app/template/dz-JCO" alt="Deploy to Railway"> <img width="150" alt="Deploy to Railway" src="https://railway.app/button.svg" /> </a> <a href="https://app.koyeb.com/deploy?type=docker&image=docker.flipt.io/flipt/flipt&ports=8080;http;/&name=flipt-demo" alt="Deploy to Koyeb"> <img width="150" alt="Deploy to Koyeb" src="https://www.koyeb.com/static/images/deploy/button.svg" /> </a> </div>

Sandbox

Try Flipt in a deployed environment!

Note: The database gets cleared every 30 minutes in this sandbox environment!

Homebrew :beer:

brew install flipt-io/brew/flipt
brew services start flipt

# or run in the foreground
flipt

Flipt UI will now be reachable at http://127.0.0.1:8080/.

Docker :whale:

docker run --rm -p 8080:8080 -p 9000:9000 -t docker.flipt.io/flipt/flipt:latest

Flipt UI will now be reachable at http://127.0.0.1:8080/.

For more permanent methods of running Flipt, see the Installation section.

Nightly Build

Like to live on the edge? Can't wait for the next release? Our nightly builds include the latest changes on main and are built.. well.. nightly.

docker run --rm -p 8080:8080 -p 9000:9000 -t docker.flipt.io/flipt/flipt:nightly

<br clear="both"/>

Supports

<p align="center"> <img src="./logos/sqlite.svg" alt="SQLite" height=75 /> <img src="./logos/mysql.svg" alt="MySQL" height=75 /> <img src="./logos/postgresql.svg" alt="PostgreSQL" height=75 /> <img src="./logos/turso.svg" alt="Turso" height=25 /> <img src="./logos/cockroachdb.svg" alt="CockroachDB" height=50 /> </p> <p align="center"> <img src="./logos/redis.svg" alt="Redis" height=75 /> <img src="./logos/prometheus.svg" alt="Prometheus" height=75 /> <img src="./logos/openid.svg" alt="OpenID" height=75 /> <img src="./logos/opentelemetry.svg" alt="OpenTelemetry" height=75 /> <img src="./logos/git.svg" alt="Git" height=50 /> </p> <br clear="both"/>

Integration

Check out our integration documentation for more info on how to integrate Flipt into your existing applications.

There are two ways to evaluate feature flags with Flipt:

• Server Side
• Client Side

Server Side Evaluation

Server-side evaluation is the most common way to evaluate feature flags. This is where your application makes a request to Flipt to evaluate a feature flag and Flipt responds with the result of the evaluation.

Flipt exposes two different APIs for performing server-side evaluation:

• GRPC
• REST

GRPC

Flipt is equipped with a fully functional GRPC API. GRPC is a high-performance, low-latency, binary protocol that is used by many large-scale companies such as Google, Netflix, and more.

See our GRPC Server SDK documentation for the latest information.

REST

Flipt is equipped with a fully functional REST API. The Flipt UI is completely backed by this same API. This means that anything that can be done in the Flipt UI can also be done via the REST API.

The Flipt REST API can also be used with any language that can make HTTP requests.

See our REST Server SDK documentation for the latest information.

Client Side Evaluation

Client-side evaluation is a great way to reduce the number of requests that your application needs to make to Flipt. This is done by retrieving all of the feature flags that your application needs to evaluate and then evaluating them locally.

See our Client SDK documentation for the latest information.

<br clear="both"/>

Release Cadence

Flipt follows semantic versioning for versioning.

We aim to release a new minor version of Flipt every 2-3 weeks. This allows us to quickly iterate on new features. Bug fixes and security patches (patch versions) will be released as needed.

<br clear="both"/>

Development

Development documentation is available for those interested in contributing to Flipt.

We welcome contributions of any kind, including but not limited to bug fixes, feature requests, documentation improvements, and more. Just open an issue or pull request and we'll be happy to help out!

<br clear="both"/>

<br clear="both"/>

Examples

Check out the examples to see how Flipt works in different use cases.

<br clear="both"/>

Licensing

There are currently two types of licenses in place for Flipt:

1. Client License
2. Server License

Client License

All of the code required to generate GRPC clients in other languages as well as the Go SDK are licensed under the MIT License.

This code exists in the rpc/ directory.

The client code is the code that you would integrate into your applications, which is why a more permissive license is used.

Server License

The server code is licensed under the GPL 3.0 License.

See LICENSE.

<br clear="both"/>

Contributors ✨

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tbody> <tr> <td align="center" valign="top" width="14.28%"><a href="http://aaronraff.github.io"><img src="https://avatars0.githubusercontent.com/u/16910064?v=4?s=100" width="100px;" alt="Aaron Raff"/><br />_{<b>Aaron Raff</b>}</a><br /><a href="https://github.com/flipt-io/flipt/commits?author=aaronraff" title="Code">💻</a></td> <td align="center" valign="top" width="14.28%"><a