Unleash is the open source feature toggle service.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Thomas Heartman 9ba6be6000
feat: add environments to project created payload (#6901)
6 hours ago
.do fix: DigitalOcean template (#4287) 9 months ago
.floe docs: spelling and grammar (#6007) 3 months ago
.github chore(deps): update docker/metadata-action action to v5 (#6667) 2 weeks ago
.husky fix: update husky precommit hook to run init script if present 1 month ago
.vscode chore: adds Biome as a recommended extension for vscode (#4909) 7 months ago
coverage feat: Instance stats for export/import (#3121) 1 year ago
docker chore(deps): update dependency path-scurry to v1.10.2 (#6850) 1 week ago
docs/api/oas docs: Remove/update references to Heroku (#2099) 2 years ago
examples
frontend feat: split projects view into "my projects" and "other projects" (#6886) 7 hours ago
perf
scripts Updated scripts to use owner (#5341) 5 months ago
src feat: add environments to project created payload (#6901) 6 hours ago
test-migrations chore: enable manual testing of migrations (#5645) 4 months ago
website feat: Make Database SSL Configurable through files (#6892) 3 days ago
.dockerignore chore: Optimize docker build oss (#3951) 11 months ago
.editorconfig
.gitignore chore: generate types (#5074) 6 months ago
.lycheeignore bug: fix broken links from lychee (#5127) 6 months ago
.mergify.yml chore: mergify (#3631) 1 year ago
.node-version chore(deps): update dependency node to v18.20.2 (#6879) 6 days ago
.nvmrc chore: update to node 18 (#3527) 1 year ago
CHANGELOG.md chore: changelog update into main (#5170) 6 months ago
CODEOWNERS chore: make Alvin CODEOWNER for docs (#6547) 1 month ago
CODE_OF_CONDUCT.md Proposed version 2.1 11 months ago
CONTRIBUTING.md docs: update min versions for node and postsgres (#6778) 2 weeks ago
Dockerfile chore(deps): update node.js to v18.20.2 (#6839) 2 weeks ago
LICENSE
README.md docs minimal edit into the desc (#5245) 5 months ago
USERS.md chore: t-mobile added as a proud user (#6208) 2 months ago
app.json fix: tell heroku to not build in production mode 2 years ago
biome.json fix(website): failing build due to failure to import React 1 month ago
cliff.toml chore(deps): added task as valid prefix for miscellaneuous task 6 months ago
docker-compose.yml chore: update DATABASE_URL to use the database created via POSTGRES_D… (#4836) 7 months ago
package.json chore(deps): update dependency @types/pg to v8.11.5 (#6877) 6 days ago
renovate.json fix: freezing navigation (#6090) 3 months ago
tsconfig.json fix(import): making all imports relative and removing baseUrl (#5847) 3 months ago
yarn.lock chore(deps): update dependency @types/pg to v8.11.5 (#6877) 6 days ago

README.md

What is Unleash?

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.


Getting Started with Unleash

1. Setting Up Unleash

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

Execute the following commands:

git clone git@github.com: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.

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

Check a feature toggle

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
}

Run Unleash on a service?

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

Deploy to Heroku Deploy to DigitalOcean

Configure and run Unleash anywhere

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.


Online demo

Try out the Unleash online demo.

The Unleash online demo


Community and help — sharing is caring

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

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


Contribute to Unleash

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.

Contributors

The Unleash contributors


Features our users love

Flexibility and adaptability

Security and performance

  • 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

Looking for more features?

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


Architecture

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


Unleash SDKs

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

Official server-side SDKs:

Official front-end SDKs:

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

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


Users of Unleash

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)

The Unleash logo encircled by logos for Finn.no, nav (the Norwegian Labour and Welfare Administration), Budgets, Otovo, and Amedia. The encircling logos are all connected to the Unleash logo.


Migration guides

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!


Want to know more about Unleash?

Videos and podcasts

Articles and more