Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-10-18 20:09:08 +02:00
Code Issues Projects Releases Wiki Activity
c769e2190a
unleash.unleash/README.md
Thomas Heartman c769e2190a chore: move community and contribute sections
2022-04-06 10:24:20 +02:00

12 KiB
Raw Blame History

Unleash is an open-source feature management platform. It provides a great overview of all feature toggles/flags across all your applications and services. Unleash lets software teams all over the world take full control of how they enable new functionality to end-users.

Unleash has official client SDKs for a number of the most popular languages around. Can't find one for the language you want? Check out the community-contributed SDKs instead!

[what is feature management + unleash] [who uses Unleash? Show that you can scale from small to laaarge]

Get started in 2 steps

1. Start Unleash

With git and docker installed, it's easy to get started immediately!

Run this script:

git clone git@github.com:Unleash/unleash-docker.git
cd unleash-docker
docker compose up -d

Then point your browser to localhost:4242 and log in using

  • username: admin
  • password: unleash4all

2. Connect your SDK

Find your preferred SDK in our list of official SDKs and import it into your project. Follow the setup guides for your specific SDK.

If you use the docker compose file from the previous step, here's the configuration details you'll need to get going:

  • For front-end SDKs, use:
    • URL: http://localhost:3000
    • clientKey: proxy-client-key
  • For server-side SDKs, use:
    • Unleash API URL: http://localhost:4242
    • API token: default:development.unleash-insecure-api-token

If you use a different setup, your configuration details will most likely also be different.

Community and help

We know that learning a new tool can be hard and time-consuming. We have a growing community that loves to help out. Please don't hesitate about reaching out to get help.

Contribute to Unleash

Building Unleash is a collaborative effort, and we owe a lot of gratitude to many smart and talented individuals. Building it together with community ensures that we build a product that solves real problems for real people. We'd love to have your help too: Please feel free to open issues or provide pull requests.

Check out the CONTRIBUTING.md file for contribution guidelines and the Unleash developer guide for tips on environment setup, running the tests, and running Unleash from source.

Features

Open-Source

  • Boolean feature toggles (on/off)
  • Canary release (Gradual rollout)
  • Targeted release
  • Experimentation (A/B testing)
  • Kill Switches
  • Custom activation strategies
  • Privacy first (GDPR) where end-user data never leaves your application
  • Audit logs
  • Addons integrating with other popular tools (Slack, Teams, Datadog, etc.)
  • It is secure (Enable Secure Headers with strict HTTPS only mode)
  • Extremely scalable with evaluations on the client-side. Used in enterprises handling more than 10k req/s. Read more about our architecture
  • Dashboard to manage technical debt
  • Admin APIs
  • Flexible architecture and can be hosted anywhere
  • Docker image available

Enterprise

Unleash Enterprise builds directly on top of the Open-Source (open-core) and provides additional advanced functionality:

  • Project support
  • Advanced segmentation
  • Environments (unlimited)
  • SSO (SAML 2.0, OpenID Connect, etc)
  • A cloud offering where the Unleash team host, monitor, scale, patches, upgrades and take full backups for you
  • Self-hosted possible
  • SLA guarantees
  • Support

Unleash SDKs

In order to connect your application to Unleash you need to use a client SDK for your programming language.

Official Server SDKs:

Official Frontend SDKs:

The frontend SDKs connects via the Unleash Proxy in order to ensure Privacy, scalability and security.

Community SDKs

In addition there exists a good list of community developed SDKs, so there might already exist an implementation for your favorite programming language (e.g. Elixir, Dart, Clojure, NestJS, Kotlin, PHP and more.)

Architecture

Read more in the Unleash documentation

What is a feature toggle?

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, and have full control of how we exposed the new feature for.

Feature toggles decouple deployment of code from release of new features.

This repo contains the unleash-server, which contains the Unleash Admin UI and the Unleash API. To make use of unleash you will also need a client SDK.

Unleash Admin UI

Online demo

Segmentation

It's fine to have a system for turning stuff on and off. But sometimes we want more granular control, we want to decide who the toggle should be enabled for. This is where activation strategies come into the picture. Activation strategies take arbitrary config and allow us to enable a toggle to a specific subset of your users (segment).

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 our docs.

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

The are numbers of ways you can run Unleash.

  1. Unleash Enterprise - Cloud hosted by the Unleash Team. see plans
  2. Unleash Open-Source - Self host with Docker. Guide
  3. Unleash Open-Source - Self host with Node.js Guide
  4. Unleash Open-Source - Helm chart artifacthub.io

Run from Docker

  1. Create a network by running the following command:
docker network create unleash
  1. Start a postgres database:
docker run -e POSTGRES_PASSWORD=some_password \
  -e POSTGRES_USER=unleash_user -e POSTGRES_DB=unleash \
  --network unleash --name postgres postgres
  1. Start Unleash via docker:
docker run -p 4242:4242 \
  -e DATABASE_HOST=postgres -e DATABASE_NAME=unleash \
  -e DATABASE_USERNAME=unleash_user -e DATABASE_PASSWORD=some_password \
  -e DATABASE_SSL=false \
  --network unleash unleashorg/unleash-server

The first time Unleash starts it will create a default user which you can use to sign-in to your Unleash instance and add more users with:

  • username: admin
  • password: unleash4all

Users of Unleash

Unleash is trusted by thousands of companies all over the world (we are tracking more than 90 countries already). Proud Open-Source users:

(PS! feel free to submit your logo!)

In the media