Unleash

by Unleash

GitHub Readme.md

Unleash

Build Status Coverage Status Dependency Status devDependency Status Greenkeeper badge Deploy

Unleash is a feature toggle system, that gives you a great overview over all feature toggles across all your applications and services. It comes with official client implementations for Java, Node.js, Go, Ruby and Python.

The main motivation for doing feature toggling is to decouple the process for deploying code to production and releasing new features. This helps reducing risk, and allow us to easily manage which features to enable

Feature toggles decouple deployment of code from release of new features

This repo contains the unleash-server, which contains the admin UI and a place to ask for the status of features. In order to make use of unleash you will also need a client implementation.

Unleash UI

Online demo version available on heroku.

Activation strategies

It's fine to have a system for turning stuff on and off. But some times we want more granular control, we want to decide who to the toggle should be enabled for. This is where activation strategies comes in to the picture. Activation strategies take arbitrary config and allows us to enable a toggle in various ways.

Common activation strategies includes:

  • Active For users with a specified userId
  • GradualRollout to X-percent of our users
  • Active for our beta users
  • Active only for application instances running on host x.

Read more about activation strategies in docs/activation-strategies.md

Client implementations

We have official SDK's for Java, Node.js, Go, Ruby and Python. And we will be happy to add implementations in other languages written by you! These libraries makes it very easy to use Unleash in you application.

Official client SDK's:

Clients written by awesome enthusiasts: 🔥

The Client API

The client SDKs provides a simple abstraction making it easy to check feature toggles in your application. The code snippet below shows how you would use Unleash in Java.

if (unleash.isEnabled("AwesomeFeature")) {
  //do some magic
} else {
  //do old boring stuff
}

Running Unleash Service

Run it yourself

Unleash is open source and you are free to run your own instance. Please refer to the getting-started-guide to learn how to run the Unleash Service.

We have made a separate project which runs Unleash inside docker. Please see unleash-docker for details

Unleash as a Service (SaaS)

After numerous request we have created a separate company, Unleash-hosted, which offer Unleash as a Service. Unleash-hosted allows you to focus on you core business and have someone else taking care of hosting and maintaining Unleash.

Go to unleash-hosted.com to learn more about this offering and start using Unleash today. This service also includes official support.

Developer Guide

If you want to contribute to this project you are encouraged to send issue request, or provide pull-requests. Please read the unleash developer guide to learn more on how you can contribute.

I Need help

Other resources