| id | title | slug | sidebar_position |
|---|---|---|---|
index |
Introduction |
/ |
1 |
:::note The docs are currently undergoing some heavy restructuring and development 👷♀️👷🏽 If something is unclear, don't hesitate to let us know on Slack! :::
Welcome to the Unleash documentation, your one-stop shop to everything Unleash. Whether you're just getting started or have been using Unleash for years, you should be able to find answers to all your questions here.
Have questions that you can't find the answer to in these docs? You can always turn to the Unleash Slack community and ask us questions directly (or just come and hang out 😄).
Our documentation is split into four parts, using the Diataxis documentation framework: documentation, how-to guides, topic guides, and reference documentation.
New to Unleash? Not sure where to get started? The tutorials guide you through taking your first steps with Unleash.
Our how-to guides show you how to perform a number of common tasks that you'll want to do. Think of them as recipes. They are more advanced than the tutorials and assume you have some working knowledge of Unleash.
Topic guides discuss high-level concepts related to Unleash and provide extra background information and explanations around these concepts.
The reference docs contain technical reference for Unleash and the API. Go here to find out how Unleash works and what configuration options are available. They're like an Unleash encyclopedia and assume you have a grip on key Unleash concepts.
💻 The core of Unleash is all open source and hosted on GitHub.
💬 If you've got questions or just wanna chat to the team and other Unleash users, come join our Slack community
🐦 You can also follow us on Twitter, LinkedIn, or Instagram for more updates and extra content.
Our goal with our documentation is to guide you through the most essential concepts of Unleash.
One of the most important aspects of the architecture to understand is that feature toggles are evaluated in a client SDKs which runs as part of your application. This makes toggle evaluations super-fast (we're talk nano-seconds), scalable and resilient against network disturbances. In order to achieve this Unleash compromises a small update-delay when you change your toggle configurations until it is fully propagated to your application (in terms of seconds and is configurable).
If you want more details you can read about our unique architecture.
Before you can connect your application to Unleash you need a Unleash server. You have a few options available:
- Unleash Open-source
- Unleash Enterprise
- Unleash API - The service holding all feature toggles and their configurations. Configurations declare which activation strategies to use and which parameters they should get. API documentation
- Unleash Admin UI - The dashboard used to manage feature toggles, define new strategies, look at metrics, etc. Create your first feature toggle
- Unleash SDK - Used by clients to check if a feature is enabled or disabled. The SDK also collects metrics and sends them to the Unleash API. See all our SDKs
- Unleash Proxy - Sits between frontend/native applications and the Unleash API. Ensures high performance and that you don't expose the full feature toggle configuration to end-users. Read more about Unleash Proxy
To be super fast (we're talking nano-seconds), the client SDK caches all feature toggles and their current configuration in memory. The activation strategies are also implemented in the SDK. This makes it really fast to check if a toggle is on or off because it is just a simple function operating on local state, without the need to poll data from the database.