├── .dockerignore ├── .github ├── release.yml ├── stale.yml └── workflows │ └── add-to-project.yml ├── .gitignore ├── Dockerfile ├── LICENSE.md ├── README.md ├── docker-compose.yml └── wait-for /.dockerignore: -------------------------------------------------------------------------------- 1 | * 2 | !wait-for 3 | -------------------------------------------------------------------------------- /.github/release.yml: -------------------------------------------------------------------------------- 1 | changelog: 2 | exclude: 3 | labels: 4 | - ignore-for-release 5 | - skip 6 | - ci 7 | authors: 8 | - dependabot 9 | categories: 10 | - title: Breaking Changes 🛠 11 | labels: 12 | - Semver-Major 13 | - Breaking 14 | - breaking 15 | - breaking-change 16 | - title: Exciting New Features 🎉 17 | labels: 18 | - Semver-Minor 19 | - enhancement 20 | - feat 21 | - title: Bug fixes 🐛 22 | labels: 23 | - fix 24 | - bug 25 | - title: Maintenance 🧹 26 | labels: 27 | - chore 28 | -------------------------------------------------------------------------------- /.github/stale.yml: -------------------------------------------------------------------------------- 1 | _extends: .github 2 | -------------------------------------------------------------------------------- /.github/workflows/add-to-project.yml: -------------------------------------------------------------------------------- 1 | name: Add new item to project board 2 | 3 | on: 4 | issues: 5 | types: 6 | - opened 7 | pull_request_target: 8 | types: 9 | - opened 10 | 11 | jobs: 12 | add-to-project: 13 | uses: unleash/.github/.github/workflows/add-item-to-project.yml@main 14 | secrets: inherit 15 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | npm-debug 3 | .DS_Store 4 | package-lock.json 5 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM unleashorg/unleash-server:4.16.4 2 | 3 | COPY wait-for /unleash/ 4 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2019 Unleash-hosted.com 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## Unleash in Docker compose 2 | This repo contains a docker compose file and an extended dockerfile for running the Unleash server. The docker compose file will start a database, the Unleash server, and an Unleash proxy. 3 | 4 | The extended Unleash dockerfile is very small shim on top of [unleash/unleash](https://github.com/Unleash/unleash/) to include wait-for and allow the docker-compose configuration to ensure that we're not starting Unleash until the database is up and running. 5 | 6 | #### Docker-compose 7 | 8 | 1. Clone the [unleash-docker](https://github.com/Unleash/unleash-docker) repository. 9 | 2. Run `docker-compose build` in repository root folder. 10 | 3. Run `docker-compose up` in repository root folder. 11 | 12 | **Useful links:** 13 | 14 | - [Docker image on dockerhub](https://hub.docker.com/r/unleashorg/unleash-server/) 15 | - [Unleash Helm Chart on artifacthub](https://artifacthub.io/packages/helm/unleash/unleash) 16 | 17 | ### User accounts 18 | - Once started up, you'll have a user with 19 | - `username: admin` 20 | - `password: unleash4all` 21 | 22 | 23 | ## Work locally with this repo 24 | Start by cloning this repository. 25 | 26 | We have set up `docker-compose` to start postgres and the unleash server together. This makes it really fast to start up 27 | unleash locally without setting up a database or node. 28 | 29 | ```bash 30 | $ docker-compose build 31 | $ docker-compose up 32 | ``` 33 | On some computers the database won't start in time for Unleash the first time you run this. If Unleash fails to reach the database, `docker-compose restart web` usually resolves the issue. 34 | 35 | ### Requirements 36 | We are using docker-compose version 3.9 and it requires: 37 | 38 | - Docker engine 19.03.0+ 39 | - Docker compose 2.0.0+ 40 | 41 | For more info, check out the compatibility matrix on Docker's website: [compatibility-matrix]( 42 | https://docs.docker.com/compose/compose-file/compose-versioning/#compatibility-matrix) 43 | 44 | 45 | 46 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | # This docker compose setup configures: 2 | # - the Unleash server instance + the necessary backing Postgres database 3 | # - the Unleash proxy 4 | # 5 | # To learn more about all the parts of Unleash, visit 6 | # https://docs.getunleash.io 7 | # 8 | # NOTE: please do not use this configuration for production setups. 9 | # Unleash does not take responsibility for any data leaks or other 10 | # problems that may arise as a result. 11 | # 12 | # This is intended to be used for demo, development, and learning 13 | # purposes only. 14 | 15 | version: "3.9" 16 | services: 17 | # the Unleash proxy is used for front-end clients, such as the 18 | # JavaScript Proxy Client SDK and the React SDK. 19 | # 20 | # For security reasons, front-end clients shouldn't (and can't) talk 21 | # directly to the Unleash server. 22 | proxy: 23 | image: unleashorg/unleash-proxy:v0.10.4 24 | ports: 25 | - "3000:3000" 26 | environment: 27 | # Proxy clients must use one of these keys to connect to the 28 | # Proxy. To add more keys, separate them with a comma (`key1,key2`). 29 | UNLEASH_PROXY_CLIENT_KEYS: "proxy-client-key" 30 | # This points the Proxy to the Unleash server API 31 | UNLEASH_URL: "http://web:4242/api" 32 | # This is the API token that the Proxy uses to communicate with 33 | # the Unleash server. 34 | # 35 | # NOTE: It *must* match one of the client tokens defined in 36 | # `web.environment.INIT_CLIENT_API_TOKENS` 37 | UNLEASH_API_TOKEN: "default:development.unleash-insecure-api-token" 38 | depends_on: 39 | - web 40 | healthcheck: 41 | test: wget --no-verbose --tries=1 --spider http://localhost:3000/proxy/health || exit 1 42 | interval: 1s 43 | timeout: 1m 44 | retries: 5 45 | 46 | 47 | # The Unleash server contains the Unleash configuration and 48 | # communicates with server-side SDKs and the Unleash Proxy 49 | web: 50 | build: . 51 | ports: 52 | - "4242:4242" 53 | environment: 54 | # This points Unleash to its backing database (defined in the `db` section below) 55 | DATABASE_URL: "postgres://postgres:unleash@db/postgres" 56 | # Disable SSL for database connections. @chriswk: why do we do this? 57 | DATABASE_SSL: "false" 58 | # Initialize Unleash with a default set of client API tokens. To 59 | # initialize Unleash with multiple tokens, separate them with a 60 | # comma (`token1,token2`). 61 | # 62 | # These tokens can be used by the Proxy or by *server-side* client 63 | # SDKs. For front-end client SDKs that talk to the Proxy, use a 64 | # key from `proxy.environment.UNLEASH_PROXY_CLIENT_KEYS` 65 | # instead. 66 | INIT_CLIENT_API_TOKENS: "default:development.unleash-insecure-api-token" 67 | # Changing log levels: 68 | # LOG_LEVEL: "debug" 69 | depends_on: 70 | - db 71 | command: ["./wait-for", "db:5432", "--", "node", "index.js"] 72 | healthcheck: 73 | test: wget --no-verbose --tries=1 --spider http://localhost:4242/health || exit 1 74 | interval: 1s 75 | timeout: 1m 76 | retries: 5 77 | start_period: 15s 78 | db: 79 | expose: 80 | - "5432" 81 | image: postgres:14 82 | environment: 83 | # create a database called `db` 84 | POSTGRES_DB: "db" 85 | # trust incoming connections blindly (DON'T DO THIS IN PRODUCTION!) 86 | POSTGRES_HOST_AUTH_METHOD: "trust" 87 | healthcheck: 88 | test: ["CMD", "pg_isready", "--username=postgres", "--host=127.0.0.1", "--port=5432"] 89 | interval: 2s 90 | timeout: 1m 91 | retries: 5 92 | start_period: 10s 93 | -------------------------------------------------------------------------------- /wait-for: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # The MIT License (MIT) 4 | # 5 | # Copyright (c) 2017 Eficode Oy 6 | # 7 | # Permission is hereby granted, free of charge, to any person obtaining a copy 8 | # of this software and associated documentation files (the "Software"), to deal 9 | # in the Software without restriction, including without limitation the rights 10 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 11 | # copies of the Software, and to permit persons to whom the Software is 12 | # furnished to do so, subject to the following conditions: 13 | # 14 | # The above copyright notice and this permission notice shall be included in all 15 | # copies or substantial portions of the Software. 16 | # 17 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 18 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 19 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 20 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 21 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 22 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 23 | # SOFTWARE. 24 | 25 | VERSION="2.2.3" 26 | 27 | set -- "$@" -- "$TIMEOUT" "$QUIET" "$PROTOCOL" "$HOST" "$PORT" "$result" 28 | TIMEOUT=15 29 | QUIET=0 30 | # The protocol to make the request with, either "tcp" or "http" 31 | PROTOCOL="tcp" 32 | 33 | echoerr() { 34 | if [ "$QUIET" -ne 1 ]; then printf "%s\n" "$*" 1>&2; fi 35 | } 36 | 37 | usage() { 38 | exitcode="$1" 39 | cat << USAGE >&2 40 | Usage: 41 | $0 host:port|url [-t timeout] [-- command args] 42 | -q | --quiet Do not output any status messages 43 | -t TIMEOUT | --timeout=timeout Timeout in seconds, zero for no timeout 44 | -v | --version Show the version of this tool 45 | -- COMMAND ARGS Execute command with args after the test finishes 46 | USAGE 47 | exit "$exitcode" 48 | } 49 | 50 | wait_for() { 51 | case "$PROTOCOL" in 52 | tcp) 53 | if ! command -v nc >/dev/null; then 54 | echoerr 'nc command is missing!' 55 | exit 1 56 | fi 57 | ;; 58 | http) 59 | if ! command -v wget >/dev/null; then 60 | echoerr 'wget command is missing!' 61 | exit 1 62 | fi 63 | ;; 64 | esac 65 | 66 | TIMEOUT_END=$(($(date +%s) + TIMEOUT)) 67 | 68 | while :; do 69 | case "$PROTOCOL" in 70 | tcp) 71 | nc -w 1 -z "$HOST" "$PORT" > /dev/null 2>&1 72 | ;; 73 | http) 74 | wget --timeout=1 -q "$HOST" -O /dev/null > /dev/null 2>&1 75 | ;; 76 | *) 77 | echoerr "Unknown protocol '$PROTOCOL'" 78 | exit 1 79 | ;; 80 | esac 81 | 82 | result=$? 83 | 84 | if [ $result -eq 0 ] ; then 85 | if [ $# -gt 7 ] ; then 86 | for result in $(seq $(($# - 7))); do 87 | result=$1 88 | shift 89 | set -- "$@" "$result" 90 | done 91 | 92 | TIMEOUT=$2 QUIET=$3 PROTOCOL=$4 HOST=$5 PORT=$6 result=$7 93 | shift 7 94 | exec "$@" 95 | fi 96 | exit 0 97 | fi 98 | 99 | if [ $TIMEOUT -ne 0 -a $(date +%s) -ge $TIMEOUT_END ]; then 100 | echo "Operation timed out" >&2 101 | exit 1 102 | fi 103 | 104 | sleep 1 105 | done 106 | } 107 | 108 | while :; do 109 | case "$1" in 110 | http://*|https://*) 111 | HOST="$1" 112 | PROTOCOL="http" 113 | shift 1 114 | ;; 115 | *:* ) 116 | HOST=$(printf "%s\n" "$1"| cut -d : -f 1) 117 | PORT=$(printf "%s\n" "$1"| cut -d : -f 2) 118 | shift 1 119 | ;; 120 | -v | --version) 121 | echo $VERSION 122 | exit 123 | ;; 124 | -q | --quiet) 125 | QUIET=1 126 | shift 1 127 | ;; 128 | -q-*) 129 | QUIET=0 130 | echoerr "Unknown option: $1" 131 | usage 1 132 | ;; 133 | -q*) 134 | QUIET=1 135 | result=$1 136 | shift 1 137 | set -- -"${result#-q}" "$@" 138 | ;; 139 | -t | --timeout) 140 | TIMEOUT="$2" 141 | shift 2 142 | ;; 143 | -t*) 144 | TIMEOUT="${1#-t}" 145 | shift 1 146 | ;; 147 | --timeout=*) 148 | TIMEOUT="${1#*=}" 149 | shift 1 150 | ;; 151 | --) 152 | shift 153 | break 154 | ;; 155 | --help) 156 | usage 0 157 | ;; 158 | -*) 159 | QUIET=0 160 | echoerr "Unknown option: $1" 161 | usage 1 162 | ;; 163 | *) 164 | QUIET=0 165 | echoerr "Unknown argument: $1" 166 | usage 1 167 | ;; 168 | esac 169 | done 170 | 171 | if ! [ "$TIMEOUT" -ge 0 ] 2>/dev/null; then 172 | echoerr "Error: invalid timeout '$TIMEOUT'" 173 | usage 3 174 | fi 175 | 176 | case "$PROTOCOL" in 177 | tcp) 178 | if [ "$HOST" = "" ] || [ "$PORT" = "" ]; then 179 | echoerr "Error: you need to provide a host and port to test." 180 | usage 2 181 | fi 182 | ;; 183 | http) 184 | if [ "$HOST" = "" ]; then 185 | echoerr "Error: you need to provide a host to test." 186 | usage 2 187 | fi 188 | ;; 189 | esac 190 | 191 | wait_for "$@" 192 | --------------------------------------------------------------------------------