mirror of
https://github.com/Unleash/unleash.git
synced 2025-08-13 13:48:59 +02:00
Apply suggestions from code review
Co-authored-by: Melinda Fekete <melinda.fekete@getunleash.io>
This commit is contained in:
parent
5b3d4fb744
commit
340a866fcd
@ -163,7 +163,7 @@ Now, let's connect our project to Unleash so that you can toggle a feature flag
|
|||||||
You'll need two things:
|
You'll need two things:
|
||||||
|
|
||||||
- The URL of your Unleash instance's API. It's `http://localhost:4242/api/` for your local version.
|
- The URL of your Unleash instance's API. It's `http://localhost:4242/api/` for your local version.
|
||||||
- A [client API token](/reference/api-tokens-and-client-keys#backend-tokens). You can create one inside a project in **Settings > API access**.
|
- A [backend token](/reference/api-tokens-and-client-keys#backend-tokens). You can create one inside a project in **Settings > API access**.
|
||||||
|
|
||||||
You can now initialize your Unleash client as follows:
|
You can now initialize your Unleash client as follows:
|
||||||
|
|
||||||
|
@ -30,7 +30,7 @@ If you're using a hosted version of Unleash, we can also run the proxy for you.
|
|||||||
This is what you need before you can run the proxy:
|
This is what you need before you can run the proxy:
|
||||||
|
|
||||||
- A running Unleash server to connect to. You'll need its API path (e.g. `https://app.unleash-hosted.com/demo/api`) to connect the proxy to it.
|
- A running Unleash server to connect to. You'll need its API path (e.g. `https://app.unleash-hosted.com/demo/api`) to connect the proxy to it.
|
||||||
- A [client API token](../reference/api-tokens-and-client-keys#backend-tokens) for the proxy to use.
|
- A [backend token](../reference/api-tokens-and-client-keys#backend-tokens) for the proxy to use.
|
||||||
- If you're running the Proxy via Docker: [the `docker` command line tool](https://www.docker.com/).
|
- If you're running the Proxy via Docker: [the `docker` command line tool](https://www.docker.com/).
|
||||||
- If you're running the Proxy as a Node.js app: [Node.js and its command line tools](https://nodejs.org/).
|
- If you're running the Proxy as a Node.js app: [Node.js and its command line tools](https://nodejs.org/).
|
||||||
- A [Proxy client key](../reference/api-tokens-and-client-keys#proxy-client-keys). This can be any arbitrary string (for instance: `proxy-client-key`). Use this key when connecting a client SDK to the Proxy.
|
- A [Proxy client key](../reference/api-tokens-and-client-keys#proxy-client-keys). This can be any arbitrary string (for instance: `proxy-client-key`). Use this key when connecting a client SDK to the Proxy.
|
||||||
|
@ -88,7 +88,7 @@ unleash.on("synchronized", () => {
|
|||||||
|
|
||||||
1. **Create an API token**
|
1. **Create an API token**
|
||||||
|
|
||||||
In the Unleash Admin UI, create a [client API token](/reference/api-tokens-and-client-keys#backend-tokens) in **Admin settings > Access control > API access**.
|
In the Unleash Admin UI, create a [backend token](/reference/api-tokens-and-client-keys#backend-tokens) in **Admin settings > Access control > API access**.
|
||||||
2. **Get your Unleash API URL**
|
2. **Get your Unleash API URL**
|
||||||
|
|
||||||
Find the base URL of your Unleash Cloud instance (for example, `https://us.app.unleash-hosted.com/some-instance-id`). Your API URL is this base URL with `/api` appended to it.
|
Find the base URL of your Unleash Cloud instance (for example, `https://us.app.unleash-hosted.com/some-instance-id`). Your API URL is this base URL with `/api` appended to it.
|
||||||
|
Loading…
Reference in New Issue
Block a user