diff --git a/README.md b/README.md index f59d0729..7013a4f8 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![crates.io](https://img.shields.io/crates/v/unleash-edge?label=latest)](https://crates.io/crates/unleash-edge) [![Documentation](https://docs.rs/unleash-edge/badge.svg?version=latest)](https://docs.rs/unleash-edge/latest) ![MIT licensed](https://img.shields.io/crates/l/unleash-edge.svg) -[![Dependency Status](https://deps.rs/crate/unleash-edge/2.0.2/status.svg)](https://deps.rs/crate/unleash-edge/2.0.2) +[![Dependency Status](https://deps.rs/crate/unleash-edge/3.0.0/status.svg)](https://deps.rs/crate/unleash-edge/3.0.0) [![CI](https://github.com/Unleash/unleash-edge/actions/workflows/test-with-coverage.yaml/badge.svg)](https://github.com/Unleash/unleash-edge/actions/workflows/test-with-coverage.yaml) [![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash-edge/badge.svg?branch=main)](https://coveralls.io/github/Unleash/unleash-edge?branch=main) ![downloads](https://img.shields.io/crates/d/unleash-edge.svg) diff --git a/server/README.md b/server/README.md index bdbf8938..7013a4f8 100644 --- a/server/README.md +++ b/server/README.md @@ -3,7 +3,7 @@ [![crates.io](https://img.shields.io/crates/v/unleash-edge?label=latest)](https://crates.io/crates/unleash-edge) [![Documentation](https://docs.rs/unleash-edge/badge.svg?version=latest)](https://docs.rs/unleash-edge/latest) ![MIT licensed](https://img.shields.io/crates/l/unleash-edge.svg) -[![Dependency Status](https://deps.rs/crate/unleash-edge/2.0.2/status.svg)](https://deps.rs/crate/unleash-edge/2.0.2) +[![Dependency Status](https://deps.rs/crate/unleash-edge/3.0.0/status.svg)](https://deps.rs/crate/unleash-edge/3.0.0) [![CI](https://github.com/Unleash/unleash-edge/actions/workflows/test-with-coverage.yaml/badge.svg)](https://github.com/Unleash/unleash-edge/actions/workflows/test-with-coverage.yaml) [![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash-edge/badge.svg?branch=main)](https://coveralls.io/github/Unleash/unleash-edge?branch=main) ![downloads](https://img.shields.io/crates/d/unleash-edge.svg) @@ -19,6 +19,10 @@ Unleash Edge offers two important features: Unleash Edge is built to help you scale Unleash, if you're looking for the easiest way to connect your client SDKs you can check out our [Frontend API](https://docs.getunleash.io/reference/front-end-api). +## Migrating to Edge from the Proxy + +For more info on migrating, check out the [migration guide](./migration-guide.md) that details the differences between Edge and the Proxy and how to achieve similar behavior in Edge. + ## Running Unleash Edge Unleash Edge is compiled to a single binary. You can configure it by passing in arguments or setting environment variables. @@ -70,7 +74,7 @@ Unleash Edge is distributed as a binary and as a docker image. - For Github package registry use the coordinates `ghpr.io/unleash/unleash-edge:` - If you'd like to live on the edge (sic) you can use the tag `edge`. This is built from `HEAD` on each commit - When running the docker image, the same CLI arguments that's available when running the binary is available to your `docker run` command. To start successfully you will need to decide which mode you're running in. - - If running in `edge` mode your command should be + - If running in `edge` mode your command should be - `docker run -p 3063:3063 -e UPSTREAM_URL= unleashorg/unleash-edge:v2.0.1 edge` - If running in `offline` mode you will need to provide a volume containing your feature toggles file. An example is available inside the examples folder. To use this, you can use the command - `docker run -v ./examples:/edge/data -p 3063:3063 -e BOOTSTRAP_FILE=/edge/data/features.json -e TOKENS='my-secret-123' unleashorg/unleash-edge:v2.0.1 offline`