docs: Updated to prepare for v6 and Node20/removal of passport from O…

…SS (#148) * docs: Updated to prepare for v6 and Node20/removal of passport from OSS Co-authored-by: Nuno Góis <[email protected]>
Unleash · May 29, 2024 · 78963df · 78963df
1 parent b712921
commit 78963df
Show file tree

Hide file tree

Showing 9 changed files with 70 additions and 317 deletions.
diff --git a/.github/workflows/buildpush.yml b/.github/workflows/buildpush.yml
@@ -10,7 +10,6 @@ jobs:
     strategy:
       matrix:
         version:
-          - 18-alpine
           - 20-alpine
         folder:
           - azure

diff --git a/.github/workflows/buildtags.yml b/.github/workflows/buildtags.yml
@@ -58,4 +58,4 @@ jobs:
           cache-to: type=gha,mode=max
           labels: ${{ steps.meta.outputs.labels }}
           build-args: |
-            NODE_VERSION=18-alpine
+            NODE_VERSION=20-alpine
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -8,7 +8,6 @@ jobs:
     strategy:
       matrix:
         version:
-          - 18-alpine
           - 20-alpine
         folder:
           - azure

diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-18
+20
diff --git a/README.md b/README.md
@@ -43,23 +43,34 @@ All configuration options [available in our documentation](https://docs.getunlea
 - Once started up, you'll have to use the OIDC provider with your credentials.
 
 ### Building the docker image
-We expect a build-arg for which node-version to build with so if you're building using the docker cli, you have to use `--build-arg NODE_VERSION=14-alpine` OR `--build-arg NODE_VERSION=16-alpine`
+
+Since Unleash v6.0.0 requires Node 20, use `--build-arg NODE_VERSION=20-alpine` when building
 
 ## Upgrade version
 When we upgrade the `unleash-version` this project should be tagged with the same version number.
 
 ```bash
-git tag -a 3.7.0 -m "upgrade to unleash-server 3.7.0"
+git tag -a 6.0.0 -m "upgrade to unleash-server 6.0.0"
 git push origin main --follow-tags
 ```
 
 You might also want to update the minor tag:
 
 ```bash
-git tag -d 3.7
-git push origin :3.7
-git tag -a 3.7 -m "Update 3.7 tag"
+git tag -d 6.0
+git push origin :6.0
+git tag -a 6.0 -m "Update 6.0 tag"
 git push origin main --follow-tags
 ```
 
 This will automatically trigger a github actions which will build the new tag and push it to docker-hub. 
+
+
+## Looking for SSO and coming from https://github.com/Unleash/helm-charts ?
+
+The old way of configuring SSO with a custom index.js in a config-map is no longer needed. These images handle the custom index.js file for you. However, you will have to configure environment variables (probably better to use secrets) as documented further up. For both Azure and OpenID the three environment variables you'll need are:
+
+* UNLEASH_AUTH_TENANT_ID
+* UNLEASH_AUTH_CLIENT_ID
+* UNLEASH_AUTH_CLIENT_SECRET
+
diff --git a/platforms/azure/package.json b/platforms/azure/package.json
@@ -7,15 +7,15 @@
     "test:ci": "echo 'no tests for unleash-docker'"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=20"
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
     "@passport-next/passport": "^3.1.0",
     "basic-auth": "^2.0.1",
     "passport": "^0.7.0",
-    "passport-azure-ad": "^4.3.1",
+    "passport-azure-ad": "^4.3.5",
     "unleash-server": "5.12.4"
   },
   "resolutions": {