flipt

module
v1.25.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 20, 2023 License: GPL-3.0

README

Flipt

An open source, self-hosted feature flag solution


Flipt Dashboard

Flipt is an open-source, self-hosted feature flag application that allows you to run experiments across services in your environment.

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.


Console - Developer Tool of the Week

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 allowing you to control who sees what
  • Enabling continuous configuration by changing values during runtime without additional deployments

Features

  • Fast. Written in Go. Optimized for performance
  • Stand alone, single binary that's easy to run and configure
  • Ability to create advanced distribution rules to target segments of users
  • Native GRPC client SDKs to integrate with your existing GRPC architecture
  • Powerful REST API with native SDKs for easy integration
  • Modern, mobile-friendly 📱 UI and debug console
  • Dark mode 🌙
  • Supports multiple databases: Postgres, MySQL, SQLite, CockroachDB
  • Import and export to allow storing your data as code
  • Cloud-ready ☁. Runs anywhere: bare metal, PaaS, K8s, with Docker or without
  • Works with Prometheus and OpenTelemetry out of the box
  • Filesystem, S3, and Git storage backends
  • Audit logging to track changes to your data

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


Flipt Console Dark Theme

Values

  • 🔒 Security - HTTPS support. OIDC and Static Token authentication. 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 - REST, GRPC, MySQL, Postgres, CockroachDB, SQLite, Redis... Flipt supports it all.
  • 👀 Observability - Flipt integrates with Prometheus and OpenTelemetry to provide metrics and tracing. We support sending trace data to Jaeger, Zipkin, and OpenTelemetry Protocol (OTLP) backends.

Works With

SQLite MySQL PostgreSQL CockroachDB

Redis Prometheus OpenID OpenTelemetry

Git

Integration

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


Flipt Labs


REST API

Flipt is equipped with a fully functional REST API. In fact, 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.

REST Client Libraries

Language Version Status
Go Go mod stable
Node/TypeScript npm status
Java Maven Central hardening
Python pypi hardening
Rust crates.io hardening

GRPC Client Libraries

Language Version Status
Go Go mod stable
Ruby GitHub release (latest SemVer) stable
.NET Nuget beta

Generate Your Own

If a client in your language is not available for download, you can easily generate one yourself using the existing protobuf definition.

Our integration documentation has more information on how to generate your own Flipt clients in your language of choice.


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!


Open in Codespaces


Try It

Try the latest version of Flipt for yourself.

Sandbox

Try Flipt in a deployed environment!

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

Docker

docker run --rm -p 8080:8080 -p 9000:9000 -t 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 flipt/flipt:nightly

Examples

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


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 existing GRPC Go client 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.


Logos

Some of the organizations depending on Flipt in production.

Paradigm    Rokt    Asphalt    Prose    UK Ministry of Justice    Ocrolus

Using Flipt at your company? Open a PR and add your logo here!


Community

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


Feedback

If you are a user of Flipt we'd really ❤ it if you could leave a testimonial on how Flipt is working for you.


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.


Contributors ✨

Thanks goes to these wonderful people (emoji key):

Aaron Raff
Aaron Raff

💻
Rodrigo Chacon
Rodrigo Chacon

💻
Christopher Diehl
Christopher Diehl

💻
Andrew Z Allen
Andrew Z Allen

📖
Sebastien Armand
Sebastien Armand

💻
Dat Tran
Dat Tran

💻
Jon Perl
Jon Perl

⚠️ 💻
Or Elimelech
Or Elimelech

💻
giddel
giddel

💻
Eduardo
Eduardo

📖 💻
Itai Schwartz
Itai Schwartz

💻
Ikko Ashimine
Ikko Ashimine

📖
Márk Sági-Kazár
Márk Sági-Kazár

💻
Dan Piet
Dan Piet

💻
Amay Shah
Amay Shah

💻
kevin-ip
kevin-ip

💻
albertchae
albertchae

💻
Thomas Sickert
Thomas Sickert

📖
Jameel Al-Aziz
Jameel Al-Aziz

📦
George
George

💻
Chase Pierce
Chase Pierce

💻
ITO Shogo
ITO Shogo

⚠️
Yoofi Quansah
Yoofi Quansah

💻
Darin McLain
Darin McLain

💻
Adam Weiss
Adam Weiss

💡
Yuval Goihberg
Yuval Goihberg

🎨
David Stotijn
David Stotijn

💻
Matthew Notarangelo
Matthew Notarangelo

💻
Charles OConor
Charles OConor

📖
Andrew Hobson
Andrew Hobson

💻
Rudinei Goi Roecker
Rudinei Goi Roecker

💻
guangwu
guangwu

💻
Collin Driscoll
Collin Driscoll

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL