Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Updated to prepare for v6 and Node20/removal of passport from OSS #148

Merged
merged 6 commits into from
May 29, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/buildpush.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ jobs:
strategy:
matrix:
version:
- 18-alpine
- 20-alpine
folder:
- azure
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/buildtags.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 0 additions & 1 deletion .github/workflows/pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ jobs:
strategy:
matrix:
version:
- 18-alpine
- 20-alpine
folder:
- azure
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
18
20
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
- [OpenID Connect Community Docker image on dockerhub](https://hub.docker.com/r/unleashorg/unleash-community-openid-connect)
- [Official Unleash Helm Chart on artifacthub](https://artifacthub.io/packages/helm/unleash/unleash)

**Steps:**
**Steps: **Azure** **
chriswk marked this conversation as resolved.
Show resolved Hide resolved

1. Create a network by running `docker network create unleash`
2. Start a postgres database:
Expand Down Expand Up @@ -43,23 +43,33 @@ 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
chriswk marked this conversation as resolved.
Show resolved Hide resolved
* UNLEASH_AUTH_TENANT_ID
* UNLEASH_AUTH_CLIENT_ID
* UNLEASH_AUTH_CLIENT_SECRET

4 changes: 2 additions & 2 deletions platforms/azure/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand Down
Loading
Loading