mirror of
https://github.com/Unleash/unleash.git
synced 2024-12-22 19:07:54 +01:00
102 lines
5.0 KiB
Markdown
102 lines
5.0 KiB
Markdown
# Unleash
|
|
|
|
[](https://travis-ci.org/Unleash/unleash)
|
|
[](https://coveralls.io/github/Unleash/unleash?branch=master)
|
|
[](https://david-dm.org/Unleash/unleash)
|
|
[](https://david-dm.org/Unleash/unleash?type=dev)
|
|
[](https://greenkeeper.io/)
|
|
[](https://heroku.com/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 and Go.
|
|
|
|
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.
|
|
|
|
<img src="https://github.com/Unleash/unleash/raw/master/docs/assets/dashboard.png" alt="Unleash UI" width="600" />
|
|
|
|
[Online demo version available on heroku](https://unleash.herokuapp.com/#/features).
|
|
|
|
## 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](./docs/activation-strategies.md)
|
|
|
|
## Client implementations
|
|
We have offical SDK's for Java, Node.js and Go. And we will be happy to add implementations in other langugages written by you! These libraries makes it very easy to use Unleash in you application.
|
|
|
|
- [unleash/unleash-client-java](https://github.com/unleash/unleash-client-java)
|
|
- [unleash/unleash-client-node](https://github.com/unleash/unleash-client-node)
|
|
- [unleash/unleash-client-go](https://github.com/unleash/unleash-client-go)
|
|
|
|
Clients written by awesome enthusiasts:
|
|
- [stiano/unleash-client-dotnet](https://github.com/stiano/unleash-client-dotnet) (.Net Core)
|
|
- [onybo/unleash-client-core](https://github.com/onybo/unleash-client-core) (.Net Core)
|
|
- [aes/unleash-client-python](https://github.com/aes/unleash-client-python) (Python 3)
|
|
|
|
### 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.
|
|
|
|
```java
|
|
if (unleash.isEnabled("AwesomeFeature")) {
|
|
//do some magic
|
|
} else {
|
|
//do old boring stuff
|
|
}
|
|
```
|
|
|
|
|
|
# Running Unleash
|
|
|
|
## Requirements
|
|
|
|
You will need a __PostgreSQL__ 9.3+ database instance to be able to run Unleash.
|
|
|
|
When starting Unleash you must specify a database URI (can be set as environment variable DATABASE_URL)
|
|
which includes a username and password, which has the rights to migrate the database.
|
|
|
|
_Unleash_ will, at startup, check whether database migration is needed, and perform necessary migrations.
|
|
|
|
## Using Unleash
|
|
|
|
**The simplest way to get started:**
|
|
(database-url can also be set as a environment variable: DATABASE_URL)
|
|
|
|
```bash
|
|
$ npm install unleash-server -g
|
|
$ unleash -d postgres://unleash_user:password@localhost:5432/unleash -p 4242
|
|
|
|
Unleash started on http://localhost:4242
|
|
```
|
|
|
|
You can also require Unleash as a lib (recommended) and expand it with more options. Read more about this feature in the [getting started guide](./docs/getting-started.md).
|
|
|
|
### Securing Unleash
|
|
Unleash also have extension points where you can integrate Unleash with your authentication provider (OAuth 2.0). Read more about [securing unleash](./docs/securing-unleash.md).
|
|
|
|
## Run with docker
|
|
We have made a separate project which runs unleash inside docker. Please see [unleash-docker](https://github.com/Unleash/unleash-docker)
|
|
|
|
# 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](./docs/developer-guide.md) to learn more on how you can contribute.
|
|
|
|
# I want to learn more
|
|
- [Blog: Unleash your features gradually!](http://bytes.schibsted.com/unleash-features-gradually/)
|
|
- [Presentation: Unleash your features gradually!](http://ivarconr.github.io/feature-toggles-presentation/sch-dev-lunch-2017/#1)
|
|
- http://martinfowler.com/bliki/FeatureToggle.html
|