diff --git a/.github/ext-logos/amedia-logo.png b/.github/ext-logos/amedia-logo.png new file mode 100644 index 000000000000..891aa69a8d0f Binary files /dev/null and b/.github/ext-logos/amedia-logo.png differ diff --git a/.github/ext-logos/budgets.png b/.github/ext-logos/budgets.png new file mode 100644 index 000000000000..0b335a9df9a4 Binary files /dev/null and b/.github/ext-logos/budgets.png differ diff --git a/.github/ext-logos/finn.jpg b/.github/ext-logos/finn.jpg new file mode 100644 index 000000000000..ff57bfdf9f5e Binary files /dev/null and b/.github/ext-logos/finn.jpg differ diff --git a/.github/ext-logos/nav.jpg b/.github/ext-logos/nav.jpg new file mode 100644 index 000000000000..b2adc4d274ac Binary files /dev/null and b/.github/ext-logos/nav.jpg differ diff --git a/.github/ext-logos/otovo.png b/.github/ext-logos/otovo.png new file mode 100644 index 000000000000..37913c80d365 Binary files /dev/null and b/.github/ext-logos/otovo.png differ diff --git a/README.md b/README.md index adae07219408..02ddc3926da9 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,7 @@ Unleash comes with [official client SDKs](https://docs.getunleash.io/sdks) for a ## Features **Open-Source** + - Boolean feature toggles (on/off) - Canary release (Gradual rollout) - Targeted release @@ -31,16 +32,18 @@ Unleash comes with [official client SDKs](https://docs.getunleash.io/sdks) for a - Flexible architecture and can be hosted anywhere - [Docker image available](https://hub.docker.com/r/unleashorg/unleash-server) -**[Unleash Enterprise](https://www.getunleash.io/plans)** builds directly on top of the Open-Source and provides additional advanced functionality: +**Enterprise** + +[Unleash Enterprise](https://www.getunleash.io/plans) builds directly on top of the Open-Source (open-core) and provides additional advanced functionality: - Project support - Advanced segmentation - Environments (unlimited) - SSO (SAML 2.0, OpenID Connect, etc) -- Technical Support -- A cloud offering where the Unleash team host, monitor, scale, patches, upgrades and take full backups for you. -- Self-hosted on prem available. - +- A cloud offering where the Unleash team host, monitor, scale, patches, upgrades and take full backups for you +- Self-hosted possible +- SLA guarantees +- Support ## Client SDKs @@ -104,15 +107,44 @@ if (unleash.isEnabled("AwesomeFeature")) { The are numbers of ways you can run Unleash. -## 1. Run it yourself (on prem, self hosted) +1. Unleash Enterprise - Cloud hosted by the the Unleash Team. [see plans](https://www.getunleash.io/plans) +2. Unleash Open-Source - Self host with Docker. [Guide](https://docs.getunleash.io/deploy/getting_started#start-unleash-server) +3. Unleash Open-Source - Self host with Node.js [Guide](https://docs.getunleash.io/deploy/getting_started#start-unleash-server) +4. Unleash Open-Source - Helm chart [artifacthub.io](https://artifacthub.io/packages/helm/unleash/unleash) + +### Run from Docker + +1. Create a network by running docker network create unleash +2. Start a postgres database: + +```sh +docker run -e POSTGRES_PASSWORD=some_password \ + -e POSTGRES_USER=unleash_user -e POSTGRES_DB=unleash \ + --network unleash --name postgres postgres +``` + +3. Start Unleash via docker: + +```sh +docker run -p 4242:4242 \ + -e DATABASE_HOST=postgres -e DATABASE_NAME=unleash \ + -e DATABASE_USERNAME=unleash_user -e DATABASE_PASSWORD=some_password \ + -e DATABASE_SSL=false \ + --network unleash unleashorg/unleash-server +``` + +The first time Unleash starts it will create a default user which you can use to sign-in to you Unleash instance and add more users with: + +- username: `admin` +- password: `unleash4all` -Unleash is open source and you are free to run your own instance. The [Getting started guide](https://docs.getunleash.io/docs/deploy/getting_started) goes through all the options on how to run Unleash. +# Users of Unleash -## 2. Unleash as a Service +Unleash is trusted by thousands of companies all over the world (we are tracking more than 90 countries already). Proud Open-Source users: -After numerous request we have created a separate company, Unleash-hosted, which offer Unleash as a Service. Unleash-hosted allows you to focus on you core business and have someone else taking care of hosting and maintaining Unleash. + -Go to [getunleash.io](https://www.getunleash.io/plans) to learn more about this offering and start using Unleash today. This service also includes official support. +_(PS! feel free to submit your logo!)_ # Contribute to Unleash @@ -127,6 +159,7 @@ We know that learning a new tool can be hard and time consuming. We have a growi # In the media +- [The Code Kitchen Episode 7: Feature flags with Unleash](https://share.fireside.fm/episode/zD-4e4KI+Pr379KBv) (English) - [Utviklerpodden, 1 - Feature Flags og Unleash med Fredrik Oseberg](https://pod.space/utviklerpodden/feature-flags-og-unleash-med-fredrik-oseberg) (Norwegian) - [Node Weekly issue 380](https://nodeweekly.com/issues/380) - [Console 42 - The open-source newsletter](https://console.substack.com/p/console-42)