lazerhawk / flipt Goto Github PK

A feature flag solution that runs in your existing infrastructure

What is Flipt

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

This means that you can deploy Flipt within your existing infrastructure and not have to worry about your information being sent to a third party or the latency required to communicate across the internet.

Flipt includes native client SDKs as well as a REST API so you can choose how to best integrate Flipt with your applications.

Why Flipt

Flipt allows you to focus on building your applications without having to worry about implementing your own feature flag solution that works across your entire infrastructure.

With Flipt you can:

• Use simple on/off feature flags to toggle functionality in your applications
• Rollout features to a subset of your audience
• Use advanced segmentation to target and serve users based on custom properties that you define

On top of all this, Flipt provides a clean, modern UI so that you can always monitor the state of your feature flags and experiments in a single place.

Features

• Fast. Written in Go. Optimized for performance
• Stand alone, easy to run and configure
• Ability to create advanced distribution rules to target segments of users
• Native GRPC client SDKs to integrate with your applications
• Simple REST API
• Modern UI and debug console
• Support for multiple databases

Running Flipt

Flipt is a single, self contained binary that you run on your own servers or cloud infrastructure. There are a multitude of benefits to running Flipt yourself, including:

• 🔒 Security - 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 to another application running on the other side of the world which can add excessive latency and slow down your applications.
• ✅ Simplicity - Flipt is a single binary with no external dependencies by default.

Try It

❯ docker run --rm -p 8080:8080 -p 9000:9000 markphelps/flipt:latest

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

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

⚠️ Beta Software ⚠️

Flipt is still considered beta software until the 1.0.0 release. This means that there are likely bugs and features/configuration may change between releases. Attempts will be made to maintain backwards compatibility whenever possible.

Clients

There are two ways to communicate with the Flipt server from your applications:

1. GRPC
2. REST API

To figure out which best supports your usecase and how to get client(s) in your preferred language, see the Integration docs.

Official Clients

• markphelps/flipt-grpc-go - Go GRPC client (Go)

Third-Party Client Libraries

Client libraries built by awesome people from the Open Source community:

• Camji55/Flipt-iOS-SDK - Native iOS SDK for Flipt (Swift)
• christopherdiehl/rflipt - React components/example project to control React features backed by Flipt (React)

Databases

Flipt supports both SQLite and Postgres databases as of v0.5.0.

SQLite is enabled by default for simplicity, however you should use Postgres if you intend to run multiple copies of Flipt in a high availability configuration.

See the Configuration documentation for more information.

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.

If there are any concerns about the use of this license for the server, please open an issue on GitHub so that we can discuss publicly.

Author

• Website: https://markphelps.me
• Twitter: @mark_a_phelps
• Email: mark.aaron.phelps at gmail.com

Contributing

I 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.

Here are some good places to start:

• Help Wanted
• Good First Issue
• Documentation Help

Pro Version

My plan is to soon start working on a Pro Version of Flipt for enterprise. Along with support, some of the planned features include:

• User management/permissions
• Multiple environments
• Audit log
• Streaming updates

If you or your organization would like to help beta test a Pro version of Flipt, please get in touch with me:

• Twitter: @mark_a_phelps
• Email: mark.aaron.phelps at gmail.com