1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-06-04 01:18:20 +02:00

docs: update UI docs and screenshots for v6.10 (#9902)

This commit is contained in:
Melinda Fekete 2025-05-12 14:21:12 +02:00 committed by GitHub
parent d175a5705a
commit 148e6e0da8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
21 changed files with 55 additions and 51 deletions

View File

@ -163,7 +163,7 @@ Now that we covered change requests as a practical tool for both feature managem
Highly regulated industries like finance and healthcare typically require extensive log preservation, maintaining detailed records for up to seven years. For most enterprise environments, a three-year retention period provides a balance between compliance and operational efficiency. Unleash provides this insight for your teams and security reviewers in a transparent, detailed, and searchable way. You can also track changes using the global [event timeline](/reference/events#event-timeline) to review recent events for up to 48 hours per environment. Event logs also capture API calls that come in from your applications and services.
In the Unleash Admin UI, go to **Admin > Event log** to see chronological events with metadata and change diffs. You can use the filter or the search bar to narrow down specific events you may be looking for. And not only are your events visible in Unleash, theyre also reportable. You can export your events as a CSV or JSON file to send to analytics tools.
In the Unleash Admin UI, go to **Admin settings > Event log** to see chronological events with metadata and change diffs. You can use the filter or the search bar to narrow down specific events you may be looking for. And not only are your events visible in Unleash, theyre also reportable. You can export your events as a CSV or JSON file to send to analytics tools.
### Integrate SIEM for advanced audit compliance

View File

@ -23,7 +23,7 @@ To ensure proper user authentication and reduce risk exposure, Unleash provides
Unleash supports any SSO option through OpenID Connect or SAML 2.0, including identity providers like Okta, Microsoft Entra ID, and Keycloak to create a unified authentication process.
To configure SSO for feature flags, navigate to **Admin > Single sign-on** in the Unleash Admin UI.
To configure SSO for feature flags, navigate to **Admin settings > Single sign-on** in the Unleash Admin UI.
![In Unleash's Single Sign-On page, there are four tabs to set up Open ID Connect, SAML 2.0, traditional passwords, and SCIM.](/img/use-case-user-mgmt-saml.png)
@ -72,7 +72,7 @@ This automation creates an access control system that adapts in real-time to org
[Role-based access control](/reference/rbac) makes feature flag management a strategic governance tool. Consider a scenario in which a junior developer should never be able to modify critical feature flags in the authentication system within a banking platform. RBAC makes this granular control seamless. We recommend carefully delegating administrative privileges to users based on the needs of their roles within projects and the organization, a concept known as the principle of least privilege.
In the Unleash Admin UI, go to **Admin > Roles** to view, create, and manage user roles.
In the Unleash Admin UI, go to **Admin > User config > Root roles** to view, create, and manage user roles at the root level, or **Project roles** to manage roles at the project level.
![Manage all user roles in the Unleash Admin UI.](/img/use-case-user-mgmt-root-roles.png)
@ -107,7 +107,7 @@ For example, customize root permissions to perform CRUD operations for:
- Segments
- Context fields
In the Unleash Admin UI, go to **Admin > Roles** and click **New root role**. In the form, select each permission you want the custom root role to have in the dropdowns and click **Add role**.
In the Unleash Admin UI, go to **Admin > User config > Root roles** and click **New root role**. In the form, select each permission you want the custom root role to have in the dropdowns and click **Add role**.
![In the "New root role" form, name your role, add a description, and select permissions in each dropdown section in the form.](/img/use-case-user-mgmt-custom-role.png)

View File

@ -33,7 +33,7 @@ To configure SSO for the new application, do the following:
1. In the overview page of the application, go to **Manage > Single sign-on** and click **SAML**.
2. In the **Basic SAML Configuration** section, click **Edit**.
3. Click **Add identifier** and enter the Unleash identifier. For hosted instances, that is `https://<region>.app.unleash-hosted.com/<your_unleash_instance_name>`.
4. Click **Add reply URL** and enter the URL shown in the Unleash Admin UI at **Admin > Single sign-on > SAML 2.0**. For example, `<your_unleash_url>/auth/saml/callback`.
4. Click **Add reply URL** and enter the URL shown in the Unleash Admin UI at **Admin settings > Single sign-on > SAML 2.0**. For example, `<your_unleash_url>/auth/saml/callback`.
5. Click **Save**.
### Manage attributes and claims
@ -73,7 +73,7 @@ To find your Microsoft Entra identifier, go to the single sign-on settings of yo
To finalize the configuration, do the following:
1. In the Unleash Admin UI, go to **Admin > Single sign-on > SAML 2.0**.
1. In the Unleash Admin UI, go to **Admin settings > Single sign-on > SAML 2.0**.
2. In **Entity ID**, enter your [Microsoft Entra identifier](#microsoft-entra-identifier).
3. In **Single sign-on URL**, enter your [Login URL](#login-url).
4. In **X.509 Certificate**, [enter your SAML certificate](#saml-certificate).
@ -101,6 +101,6 @@ Microsoft Entra limits the number of groups emitted in a SAML response to 150, i
:::
To enable group syncing in Unleash, do the following:
1. In the Unleash Admin UI, go to **Admin > Single sign-on > SAML 2.0**.
1. In the Unleash Admin UI, go to **Admin settings > Single sign-on > SAML 2.0**.
2. Select **Enable Group Syncing** and add the name in your group in Group Field JSON Path.
3. Click **Save**.

View File

@ -3,7 +3,7 @@ title: How to create API Tokens
---
Depending on your [permissions](../reference/api-tokens-and-client-keys#api-token-permissions), you can create API tokens in the Unleash Admin UI in three ways:
- **Admin > API access**: for client or frontend tokens; requires the Admin root role, or a custom root role with API token permissions.
- **Admin settings > Access control > API access**: for client or frontend tokens; requires the Admin root role, or a custom root role with API token permissions.
- **Settings > API access** inside a project: for project-specific client or frontend tokens; permitted for project Members or users with a [corresponding root role](../reference/api-tokens-and-client-keys#api-token-permissions).
- **Profile > View profile settings > Personal API tokens**: for personal access tokens.

View File

@ -37,7 +37,7 @@ In your browser, go to [http://localhost:4242](http://localhost:4242) and log in
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**.
In the Admin UI, go to **Admin settings > Instance config > 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.

View File

@ -138,7 +138,7 @@ be44368985f7fb3237c584ef86f3d6bdada42ddbd63a019d26955178
## Create an API token
Depending on your [permissions](#api-token-permissions), you can create API tokens in the Unleash Admin UI in three ways:
- **Admin > API access**: for client or frontend tokens; requires the Admin root role, or a custom root role with [API token permissions](#api-token-permissions).
- **Admin settings > Access control > API access**: for client or frontend tokens; requires the Admin root role, or a custom root role with [API token permissions](#api-token-permissions).
- **Settings > API access** inside a project: for project-specific client or frontend tokens; permitted for project Members or users with a [corresponding root role](#api-token-permissions).
- **Profile > View profile settings > Personal API tokens**: for [personal access tokens](#personal-access-tokens).

View File

@ -13,7 +13,7 @@ You can use Event Log for auditing purposes, while Event Timeline is particularl
The Event Log lists all events in your Unleash instance. You can search and filter events by date range, event type, project, feature flag, and user. You can also export events as CSV or JSON files.
To access events in the Admin UI, you need Admin access. To view all events, go to **Admin > Event log**. To view events for a specific feature flag, go to the **Event log** tab on that feature flag's page.
To access events in the Admin UI, you need Admin access. To view all events, go to **Admin settings > Event log**. To view events for a specific feature flag, go to the **Event log** tab on that feature flag's page.
Each [event type](#event-types) contains different data, but all events follow the same schema:

View File

@ -22,7 +22,7 @@ Since the Frontend API shares the same API as Unleash Edge, you can start develo
For web and hybrid mobile apps, allow traffic from your application's domains.
For Unleash, you can update CORS settings in the Unleash Admin UI in **Admin > CORS origins**. For Unleash Edge, follow our [command-line for CORS settings](https://github.com/Unleash/unleash-edge/blob/243cfbdf2ef5f78a7312db6cc688cc74b7d5f318/CLI.md).
For Unleash, you can update CORS settings in the Unleash Admin UI in **Admin settings > Access control > CORS origins**. For Unleash Edge, follow our [command-line for CORS settings](https://github.com/Unleash/unleash-edge/blob/243cfbdf2ef5f78a7312db6cc688cc74b7d5f318/CLI.md).
### Configure the API URL

View File

@ -14,7 +14,7 @@ To use these dashboards, you must configure an [external data source](#configure
Requests from Unleash SDKs and other official Unleash applications include an application name. Requests that don't include an application name header (`UNLEASH_APPNAME`) are marked and aggregated as *unknown*.
You can access the **Network** dashboards in **Admin > Network** in the Unleash Admin UI.
You can access the **Network** dashboards in **Admin settings > Network** in the Unleash Admin UI.
## Overview

View File

@ -267,7 +267,7 @@ role that encapsulates the needed permissions.
The access overview page helps administrators see exactly what a user can do in Unleash and which roles grant those permissions. You can explore permissions at the root level or for specific environments and projects.
To view a users permissions, go to **Admin > Users**. Select a user and click **Access overview**.
To view a users permissions, go to **Admin settings > User config > Users**. Select a user and click **Access overview**.
## User groups

View File

@ -13,7 +13,7 @@ Service accounts provide an identity for integration and automation tools to acc
## Create a service account
To create service accounts in the Unleash Admin UI:
1. Go to **Admin > Service accounts.**
1. Go to **Admin settings > Service accounts.**
2. Enter a name and username for the service account and select a root role.
3. Optionally, create and assign a service account token. You can also generate one later.
4. Click **Save service account**.

View File

@ -13,7 +13,7 @@ title: Single Sign-On
Unleash provides single sign-on (SSO) support through SAML 2.0, OpenID Connect, and username/password authentication.
To configure SSO, navigate to **Admin > Single sign-on** in the Unleash Admin UI. Admin access is required.
To configure SSO, navigate to **Admin settings > Single sign-on** in the Unleash Admin UI. Admin access is required.
For step-by-step configuration instructions, refer to the following guides:
- [OpenID Connect with Okta](../how-to/how-to-add-sso-open-id-connect)

View File

@ -14,7 +14,7 @@ When running Unleash using Docker, configuration is managed through environment
### Docker Compose
<Tabs groupId="setup-method">
<TabItem value="docker-compose-enterprise" label="Unleash Enterprise">
<TabItem value="docker-compose-enterprise" label="Enterprise">
Update the `environment:` section of your `docker-compose-enterprise.yml` file. For example:
```yaml
services:
@ -28,7 +28,7 @@ services:
</TabItem>
<TabItem value="docker-compose-oss" label="Unleash OSS">
<TabItem value="docker-compose-oss" label="Open Source">
Update the `environment:` section of your `docker-compose.yml` file. For example:
```yaml
services:
@ -46,7 +46,7 @@ services:
### Docker CLI
<Tabs groupId="setup-method">
<TabItem value="docker-cli-enterprise" label="Unleash Enterprise">
<TabItem value="docker-cli-enterprise" label="Enterprise">
Use the `-e` flag in your `docker run` command. For example:
@ -56,7 +56,7 @@ docker run -e DATABASE_HOST=mydbhost -e DATABASE_SSL=false ... unleashorg/unleas
</TabItem>
<TabItem value="docker-cli-oss" label="Unleash OSS">
<TabItem value="docker-cli-oss" label="Open Source">
Use the `-e` flag in your `docker run` command. For example:

View File

@ -82,22 +82,6 @@ docker run -d \
This command starts the Unleash server, maps port `4242` on your host to the container, connects to the PostgreSQL database you started, disables database SSL, connects to the `unleash` network, and ensures you have the latest image.
<Tabs groupId="setup-method">
<TabItem value="oss" label="Open Source">
```shell
docker run -d -p 4242:4242 \
-e DATABASE_HOST=postgres \
-e DATABASE_NAME=unleash \
-e DATABASE_USERNAME=unleash_user \
-e DATABASE_PASSWORD=your_secure_password \
-e DATABASE_SSL=false \
--network unleash \
--name unleash \
--pull=always \
unleashorg/unleash-server
```
</TabItem>
<TabItem value="enterprise" label="Enterprise">
@ -115,24 +99,29 @@ docker run -d -p 4242:4242 \
```
</TabItem>
<TabItem value="oss" label="Open Source">
```shell
docker run -d -p 4242:4242 \
-e DATABASE_HOST=postgres \
-e DATABASE_NAME=unleash \
-e DATABASE_USERNAME=unleash_user \
-e DATABASE_PASSWORD=your_secure_password \
-e DATABASE_SSL=false \
--network unleash \
--name unleash \
--pull=always \
unleashorg/unleash-server
```
</TabItem>
</Tabs>
## Log in to the Unleash Admin UI
<Tabs groupId="setup-method">
<TabItem value="oss" label="Open Source">
In your browser, go to [http://localhost:4242](http://localhost:4242) and log in using the following credentials:
- **username**: `admin`
- **password**: `unleash4all`
![Unleash Admin UI log in screen](/img/quickstart-login.png)
The first time Unleash starts, it creates this default `admin` user. To use different credentials for the initial admin user, set the following environment variables before starting the Unleash container for the first time:
- `UNLEASH_DEFAULT_ADMIN_USERNAME=<your_custom_username>`
- `UNLEASH_DEFAULT_ADMIN_PASSWORD=<your_custom_secure_password>`
</TabItem>
<TabItem value="enterprise" label="Enterprise">
@ -153,6 +142,21 @@ If you are running Unleash Enterprise, you need to install a [license key](/usin
In the Admin UI, go to **Admin > License**, copy the license key you received by email and click **Update license key**.
</TabItem>
<TabItem value="oss" label="Open Source">
In your browser, go to [http://localhost:4242](http://localhost:4242) and log in using the following credentials:
- **username**: `admin`
- **password**: `unleash4all`
![Unleash Admin UI log in screen](/img/quickstart-login.png)
The first time Unleash starts, it creates this default `admin` user. To use different credentials for the initial admin user, set the following environment variables before starting the Unleash container for the first time:
- `UNLEASH_DEFAULT_ADMIN_USERNAME=<your_custom_username>`
- `UNLEASH_DEFAULT_ADMIN_PASSWORD=<your_custom_secure_password>`
</TabItem>
</Tabs>
## Test your server connection

View File

@ -56,7 +56,7 @@ Alternatively, you can reach out to sales@getunleash.io.
## Check your current license
To check your current license in the Unleash Admin UI, go to **Admin** > **License**. If you have an active license, you'll see the following information:
To check your current license in the Unleash Admin UI, go to **Admin settings > Instance config > License**. If you have an active license, you'll see the following information:
- Customer name
- Plan
- Seat count
@ -67,7 +67,7 @@ To check your current license in the Unleash Admin UI, go to **Admin** > **Licen
### Using the Admin UI
In the Unleash Admin UI, do the following:
1. Go to **Admin** > **License**.
1. Go to **Admin settings > Instance config > License**.
2. Paste the new license key and click **Update license key**.
After updating a license key, you may need to refresh your browser for the license warning banners to be removed.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 257 KiB

After

Width:  |  Height:  |  Size: 276 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 276 KiB

After

Width:  |  Height:  |  Size: 344 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 236 KiB

After

Width:  |  Height:  |  Size: 364 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 306 KiB

After

Width:  |  Height:  |  Size: 387 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 367 KiB

After

Width:  |  Height:  |  Size: 328 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 293 KiB

After

Width:  |  Height:  |  Size: 253 KiB