Repository files navigation

SimpleUnleash v5 server withGoogle IAP authentication. Built to work well withUnleasherator our Kubernetes operator for managing Unleash instances.

sequenceDiagram    participant User    participant Google IAP    participant Google Auth    participant Unleash    autonumber    User->>Google IAP: request    alt is not authenticated        Google IAP->>Google Auth: Redirect to login        Google Auth->>Google IAP: Redirect to callback    end    alt is not authorized        Google IAP->>User: 403    end    Google IAP->>Unleash: request    Unleash->>User: response

GOOGLE_IAP_JWT_AUDIENCE should be a string in the following format:

/projects/PROJECT_NUMBER/global/backendServices/SERVICE_ID

• Node.js 16 or later
• Docker

The simplest way to run Unleash is to usedocker-compose:

docker-compose up --build

This will start a local Postgres database in a Docker container and expose Unleash onhttp://localhost:8080.

To build the code, runyarn build. This will compile the TypeScript files to ES2017 and place them in./dist/. Unleash can then be run withyarn start. For convenience you can also use theyarn build-and-start command.

Running Unleash locally requires a database. The easiest way to get one is to use Docker:

docker-compose up -d postgres

This will start a local Postgres database in a Docker container. You can then connect to it using the following credentials:

export DATABASE_USERNAME=unleashexport DATABASE_PASSWORD=unleashexport DATABASE_NAME=unleashexport DATABASE_HOST=localhostexport DATABASE_SSL=false

You also need the following environment variables:

export INIT_ADMIN_API_TOKENS=*:*.unleash4allexport GOOGLE_IAP_AUDIENCE=/projects/123/global/backendServices/123

Requests and questions can be made via issues on the repo. For NAV employees this can be done easiest via the slack channel#unleash.

MIT