mirror of
https://github.com/Unleash/unleash.git
synced 2025-06-23 01:16:27 +02:00
Update Quickstart for Enterprise getting started (#9823)
This commit is contained in:
parent
3774cf8b87
commit
81c1fb9143
@ -2,7 +2,7 @@
|
||||
# - the Unleash server instance + the necessary backing Postgres database
|
||||
#
|
||||
# To learn more about all the parts of Unleash, visit
|
||||
# https://docs.getunleash.io
|
||||
# https://docs.getunleash.io/understanding-unleash/unleash-overview
|
||||
#
|
||||
# NOTE: please do not use this configuration for production setups.
|
||||
# Unleash does not take responsibility for any data leaks or other
|
||||
@ -15,7 +15,7 @@ version: "3.9"
|
||||
services:
|
||||
|
||||
# The Unleash server contains the Unleash configuration and
|
||||
# communicates with server-side SDKs and the Unleash Proxy
|
||||
# communicates with client SDKs and Unleash Edge
|
||||
web:
|
||||
image: unleashorg/unleash-enterprise:latest
|
||||
ports:
|
||||
|
@ -2,7 +2,7 @@
|
||||
# - the Unleash server instance + the necessary backing Postgres database
|
||||
#
|
||||
# To learn more about all the parts of Unleash, visit
|
||||
# https://docs.getunleash.io
|
||||
# https://docs.getunleash.io/understanding-unleash/unleash-overview
|
||||
#
|
||||
# NOTE: please do not use this configuration for production setups.
|
||||
# Unleash does not take responsibility for any data leaks or other
|
||||
@ -15,7 +15,7 @@ version: "3.9"
|
||||
services:
|
||||
|
||||
# The Unleash server contains the Unleash configuration and
|
||||
# communicates with server-side SDKs and the Unleash Proxy
|
||||
# communicates with client SDKs and Unleash Edge
|
||||
web:
|
||||
image: unleashorg/unleash-server:latest
|
||||
ports:
|
||||
|
@ -6,22 +6,26 @@ import Tabs from '@theme/Tabs';
|
||||
|
||||
import TabItem from '@theme/TabItem';
|
||||
|
||||
This guide helps you set up Unleash in just a few minutes. The fastest way to get started is by using [Docker](#set-up-unleash-with-docker). If Docker doesn't work for you, see [other ways to try Unleash](#other-ways-to-try-unleash).
|
||||
This guide helps you set up Unleash Enterprise in your own environment using [Docker](#set-up-unleash-with-docker). Alternatively, you can sign up for a [cloud-hosted trial instance](https://www.getunleash.io/pricing).
|
||||
|
||||
If you are looking to set up the open-source version of Unleash, please refer to the instructions in the [Unleash GitHub repository](https://github.com/Unleash/unleash?tab=readme-ov-file#get-started-with-unleash).
|
||||
|
||||
## Set up Unleash with Docker
|
||||
|
||||
### Start Unleash locally
|
||||
|
||||
To start Unleash locally, clone the [Unleash repository](https://github.com/Unleash/unleash) and start the server with Docker Compose:
|
||||
To start Unleash locally, clone the Unleash repository and start the server with [Docker Compose](https://docs.docker.com/compose/):
|
||||
|
||||
```shell
|
||||
git clone git@github.com:Unleash/unleash.git
|
||||
|
||||
cd unleash
|
||||
docker compose up -d
|
||||
docker compose -f docker-compose-enterprise.yml up
|
||||
```
|
||||
|
||||
### Log in to the Unleash Admin UI
|
||||
This pulls the `unleashorg/unleash-enterprise` Docker image and uses a Docker Compose file to configure the Unleash server and its database.
|
||||
|
||||
> This step uses `docker compose` (V2 syntax). If you have the older `docker-compose` (V1), use that command syntax instead.
|
||||
|
||||
## Log in to the Unleash Admin UI
|
||||
|
||||
In your browser, go to [http://localhost:4242](http://localhost:4242) and log in using the following credentials:
|
||||
- **username**: `admin`
|
||||
@ -29,7 +33,18 @@ In your browser, go to [http://localhost:4242](http://localhost:4242) and log in
|
||||
|
||||

|
||||
|
||||
### Create your first flag
|
||||
## Install your trial license
|
||||
|
||||
Request a license by signing up for a self-hosted trial [here](https://www.getunleash.io/pricing). Once you've signed up, you'll receive an email from Unleash containing your trial license key.
|
||||
|
||||
In the Admin UI, go to **Admin > License**, copy the license key you received by email and click **Update license key**.
|
||||
|
||||
The top banner now displays the number of days you have left on your free trial.
|
||||
|
||||

|
||||
|
||||
|
||||
## Create your first flag
|
||||
|
||||
To create your first flag:
|
||||
1. Open the **Default** project.
|
||||
@ -38,25 +53,21 @@ To create your first flag:
|
||||
|
||||
For more details on creating feature flags, see [How to create a feature flag](/how-to-create-feature-flag).
|
||||
|
||||
### Connect an SDK
|
||||
## Connect an SDK
|
||||
|
||||
Next, use one of the client or server-side [SDKs](/reference/sdks) to connect Unleash with your application.
|
||||
|
||||
1. Create an API token:
|
||||
- For client-side SDKs, use a [frontend token](/reference/api-tokens-and-client-keys#frontend-tokens).
|
||||
- For server-side SDKs, use a [client token](/reference/api-tokens-and-client-keys#client-tokens).
|
||||
2. Determine your Unleash URL:
|
||||
- For client-side SDKs, use `<your-unleash-instance>/api/frontend`.
|
||||
- For server-side SDKs, use `<your-unleash-instance>/api`.
|
||||
3. Use the SDK to connect to Unleash in your application.
|
||||
|
||||
The following example shows how to use the [JavaScript SDK](/reference/sdks/javascript-browser) and the [Node.js SDK](/reference/sdks/node) to connect to your Unleash instance:
|
||||
|
||||
|
||||
<Tabs groupId="connect-sdk-quickstart">
|
||||
|
||||
<TabItem value="sdk-client-side" label="Connect a client-side SDK">
|
||||
|
||||
1. Create a [frontend API token](/reference/api-tokens-and-client-keys#frontend-tokens).
|
||||
2. Determine your Unleash URL, for example: `http://localhost:4242/api/frontend`.
|
||||
3. Use the SDK to connect to Unleash in your application.
|
||||
|
||||
The following example shows how to use the [JavaScript SDK](/reference/sdks/javascript-browser) to connect to your Unleash instance:
|
||||
|
||||
```javascript title="JavaScript SDK"
|
||||
import { UnleashClient } from "unleash-proxy-client";
|
||||
|
||||
@ -79,11 +90,17 @@ unleash.on("synchronized", () => {
|
||||
</TabItem>
|
||||
<TabItem value="sdk-server-side" label="Connect a server-side SDK">
|
||||
|
||||
1. Create a [client API token](/reference/api-tokens-and-client-keys#client-tokens).
|
||||
2. Determine your Unleash URL, for example: `http://localhost:4242/api`.
|
||||
3. Use the SDK to connect to Unleash in your application.
|
||||
|
||||
The following example shows how to use the [Node.js SDK](/reference/sdks/node) to connect to your Unleash instance:
|
||||
|
||||
```javascript title="Node.js SDK"
|
||||
const { initialize } = require("unleash-client");
|
||||
|
||||
const unleash = initialize({
|
||||
url: "https://<your-unleash-instance>/api/",
|
||||
url: "https://<your-unleash-instance>/api",
|
||||
appName: "<your-app-name>",
|
||||
customHeaders: {
|
||||
Authorization: "<your-token>",
|
||||
@ -102,44 +119,8 @@ unleash.on("synchronized", () => {
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Other ways to try Unleash
|
||||
|
||||
### Unleash demo instance
|
||||
|
||||
You can also use the [Unleash demo instance](https://app.unleash-hosted.com/demo/) to test different use cases before setting up your own instance. The demo instance is available at `https://app.unleash-hosted.com/demo/`.
|
||||
|
||||
To run tests on this instance, use the following API URLs and keys:
|
||||
|
||||
- **Client-side:**
|
||||
- API URL: `https://app.unleash-hosted.com/demo/api/frontend`
|
||||
- Frontend key: `demo-app:default.bf8d2a449a025d1715a28f218dd66a40ef4dcc97b661398f7e05ba67`
|
||||
- **Server-side:**
|
||||
- API URL: `https://app.unleash-hosted.com/demo/api`
|
||||
- Client key: `56907a2fa53c1d16101d509a10b78e36190b0f918d9f122d`
|
||||
|
||||
To test the credentials and retrieve feature flags, run this command:
|
||||
|
||||
```shell
|
||||
curl https://app.unleash-hosted.com/demo/api/client/features \
|
||||
-H "Authorization: 56907a2fa53c1d16101d509a10b78e36190b0f918d9f122d"
|
||||
```
|
||||
|
||||
### Other local setup options
|
||||
|
||||
For other ways to get started locally, see the steps for [starting an Unleash server](using-unleash/deploy/getting-started#start-unleash-server).
|
||||
|
||||
## Hosting Unleash
|
||||
|
||||
#### Hosted by Unleash
|
||||
|
||||
With our [Pro](/availability#plans) and [Enterprise](https://www.getunleash.io/pricing) plans, you can run Unleash in the cloud by using our hosted offerings.
|
||||
|
||||
#### Self-hosted
|
||||
|
||||
Self-hosting Unleash is available for [Open Source](https://www.getunleash.io/pricing) and [Enterprise](https://www.getunleash.io/pricing) customers. Visit [Self-hosting Unleash](/using-unleash/deploy) to learn more.
|
||||
|
||||
## Next steps
|
||||
|
||||
Check out our reference documentation that explains all [core concepts](/reference) you need to get the most out of Unleash.
|
||||
Check out our reference documentation that explains the [Unleash architecture](/understanding-unleash/unleash-overview), the different [hosting options](/understanding-unleash/hosting-options) available, and other [core concepts](/reference) you need to get the most out of Unleash.
|
||||
|
||||
Explore feature flag best practices and language-specific tutorials in our [developer guides](/topics).
|
BIN
website/static/img/quickstart-license.png
Normal file
BIN
website/static/img/quickstart-license.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 299 KiB |
Loading…
Reference in New Issue
Block a user