unleash / client-specification Goto Github PK

Experience Unleash Live Demo →

Unleash is a powerful open source solution for feature management. It streamlines your development workflow, accelerates software delivery, and empowers teams to control how and when they roll out new features to end users. With Unleash, you can deploy code to production in smaller, more manageable releases at your own pace.

Feature flags in Unleash let you test your code with real production data, reducing the risk of negatively impacting your users' experience. It also enables your team to work on multiple features simultaneously without the need for separate feature branches.

Unleash is the most popular open source solution for feature flagging on GitHub. It supports 15 official client and server SDKs and over 15 community SDKs. You can even create your own SDK if you wish. Unleash is compatible with any language and framework.

To get started with Unleash, you need git and docker installed on your machine.

Execute the following commands:

git clone [email protected]:Unleash/unleash.git
cd unleash
docker compose up -d

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

• username: admin
• password: unleash4all

If you'd rather run the source code in this repo directly via Node.js, see the step-by-step instructions to get up and running in the contributing guide.

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:4242/api/frontend/
  • clientKey: default:development.unleash-insecure-frontend-api-token
• For server-side SDKs, use:
  • Unleash API URL: http://localhost:4242/api/
  • API token: default:development.unleash-insecure-api-token

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

Checking the state of a feature toggle in your code is easy! The syntax will vary depending on your language, but all you need is a simple function call to check whether a toggle is available. Here's how it might look in Java:

if (unleash.isEnabled("AwesomeFeature")) {
  // do new, flashy thing
} else {
  // do old, boring stuff
}

If you don't want to run Unleash locally, we also provide easy deployment setups for Heroku and Digital Ocean:

The above sections show you how to get up and running quickly and easily. When you're ready to start configuring and customizing Unleash for your own environment, check out the documentation for getting started with self-managed deployments, Unleash configuration options, or running Unleash locally via docker.

Try out the Unleash online demo.

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 to reach out for help.

💬 Join Unleash on Slack if you want ask open questions about Unleash, feature toggling or discuss these topics in general.

💻 Create a GitHub issue if you have found a bug or have ideas on how to improve Unleash.

📚 Visit the documentation for more in-depth descriptions, how-to guides, and more.

📖 Learn more about the principles of building and scaling feature flag solutions.

Unleash is the largest open source feature flag solution on GitHub. Building Unleash is a collaborative effort, and we owe a lot of gratitude to many smart and talented individuals. Building it together with the 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.

• Get an easy overview of all feature toggles across all your environments, applications and services
• Use included activation strategies for most common use cases, or use a custom activation strategy to support any need you might have
• Organise feature toggles by feature toggle tags
• Canary releases / gradual rollouts
• Targeted releases: release features to specific users, IPs, or hostnames
• Kill switches
• A/B testing
• 2 environments
• Out-of-the-box integrations with popular tools (Slack, Microsoft Teams, Datadog) + integrate with anything with webhooks
• Dashboard for managing technical debt and stale toggles
• API-first: everything can be automated. No exceptions.
• 12 official client SDKs, and ten community-contributed client SDKs
• Run it via Docker with the official Docker image or as a pure Node.js application

• Privacy by design (GDPR and Schrems II). End-user data never leaves your application.
• Audit logs
• Enforce OWASP's secure headers via the strict HTTPS-only mode
• Flexible hosting options: host it on premise or in the cloud (any cloud)
• Scale the Unleash Proxy independently of the Unleash server to support any number of front-end clients without overloading your Unleash instance

If you're looking for one of the following features, please take a look at our Pro and Enterprise plans:

• role-based access control (RBAC)
• single sign-on (SSO)
• more environments
• feature toggles project support
• advanced segmentation
• additional strategy constraints
• tighter security
• more hosting options (we can even host it for you!)

Read more in the system overview section of the Unleash documentation.

To connect your application to Unleash you'll need to use a client SDK for your programming language.

Official server-side SDKs:

• Go SDK
• Java SDK
• Node.js SDK
• PHP SDK
• Python SDK
• Ruby SDK
• Rust SDK
• .NET SDK

Official front-end SDKs:

The front-end SDKs connects via the Unleash Proxy in order to ensure privacy, scalability and security.

• Android Proxy SDK
• Flutter Proxy SDK
• iOS Proxy SDK
• JavaScript Proxy SDK
• React Proxy SDK
• Svelte Proxy SDK
• Vue Proxy SDK

Community SDKs:

If none of the official SDKs fit your need, there's also a number of community-developed SDKs where you might find an implementation for your preferred language (such as Elixir, Dart, Clojure, and more).

Unleash is trusted by thousands of companies all over the world.

Proud Open-Source users: (send us a message if you want to add your logo here)

Unleash has evolved significantly over the past few years, and we know how hard it can be to keep software up to date. If you're using the current major version, upgrading shouldn't be an issue. If you're on a previous major version, check out the Unleash migration guide!

• The Unleash YouTube channel
• Feature toggles — Why and how to add to your software — freeCodeCamp (YouTube)
• Feature flags with Unleash — The Code Kitchen (podcast)
• Feature Flags og Unleash med Fredrik Oseberg — Utviklerpodden (podcast; Norwegian)

• The Unleash Blog
• Designing the Rust Unleash API client — Medium
• FeatureToggle by Martin Fowler
• Feature toggling transient errors in load tests — nrkbeta
• An Interview with Ivar of Unleash — Console
• Unleash your features gradually, slideshow/presentation by Ivar, the creator of Unleash