Mirrors/unleash.unleash
1
0
Fork 0
mirror of https://github.com/Unleash/unleash.git synced 2024-12-22 19:07:54 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #1268 from Unleash/docs/add-steps-for-running-proxy-via-node

Browse Source 
docs: add steps for running the proxy via Node
This commit is contained in:
Thomas Heartman 2022-01-17 15:29:14 +01:00 committed by GitHub
commit 686722643b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 48 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
website/docs/sdks/unleash-proxy.md
View File

@ -41,19 +41,19 @@ Regardless of how you choose to run the it, the proxy will need access to these
When using an environment variable to set the proxy secrets, the value should be a comma-separated list of strings, such as `secret-one,secret-two`.
For more information, check out the [documentation on GitHub](https://github.com/Unleash/unleash-proxy).
There are many more configuration options available. You'll find all [available options on github](https://github.com/Unleash/unleash-proxy#available-options).
### Running the proxy via Docker
The easiest way to run Unleash is via Docker. We have published a [docker image on docker hub](https://hub.docker.com/r/unleashorg/unleash-proxy).
**Step 1: Pull**
1. **Pull the Proxy image**
```bash
docker pull unleashorg/unleash-proxy
```
**Step 2: Start**
2. **Start the proxy**
```bash
docker run \
@ -70,9 +70,36 @@ You should see the following output:
Unleash-proxy is listening on port 3000!
```
**Step 3: verify**
### Running the proxy using Node.js
In order to verify the proxy you can use curl and see that you get a few evaluated feature toggles back:
To run the Proxy via Node.js, you'll have to create your own Node.js project and use the Unleash Proxy as a dependency. Assuming you've already set up your project, here's the steps to take to start the proxy as part of your app:
1. **Install the Unleash Proxy package**
``` shell npm2yarn
npm install @unleash/proxy
```
2. **Initialize and start the proxy in your code.** A fully working sample app that uses the proxy:
``` js
const port = 3000;
const { createApp } = require('@unleash/proxy');
const app = createApp({
unleashUrl: 'https://app.unleash-hosted.com/demo/api/',
unleashApiToken: '56907a2fa53c1d16101d509a10b78e36190b0f918d9f122d',
clientKeys: ['some-secret', 'another-proxy-secret', 's1'],
refreshInterval: 1000,
});
app.listen(port, () =>
console.log(`Unleash Proxy listening on http://localhost:${port}/proxy`),
);
```
### Verify that the proxy is working
In order to verify the proxy you can use curl and see that you get a few evaluated feature toggles back. Assuming that the proxy is running on port 3000 and that your proxy client key is `some-secret`, you could run this command :
```bash
curl http://localhost:3000/proxy -H "Authorization: some-secret"
@ -80,7 +107,7 @@ curl http://localhost:3000/proxy -H "Authorization: some-secret"
The output is of the form described in the [payload section](#payload).
**Health endpoint**
### Health endpoint
The proxy will try to synchronize with the Unleash API at startup, until it has successfully done that the proxy will return `HTTP 503 - Not Read?` for all request. You can use the health endpoint to validate that the proxy is ready to recieve requests:
@ -100,7 +127,6 @@ Connection: keep-alive
Keep-Alive: timeout=5
```
There are multiple more configuration options available. You find all [available options on github](https://github.com/Unleash/unleash-proxy#available-options).
## Custom activation strategies