Use Unleash Docker Image

Useful links:

• Docker image on dockerhub
• Unleash Helm Chart on artifacthub

Steps:

1. Create a network by running docker network create unleash
2. Start a postgres database:

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:

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

All configuration options available in our documentation.

User accounts

• Once started up, you'll have a user with
  • username: admin
  • password: unleash4all

This user is an admin user and can be used to create other users, we do suggest you change the password :)

Docker-compose

1. Clone the unleash-docker repository.
2. Run docker-compose build in repository root folder.
3. Run docker-compose up in repository root folder.

Work locally with this repo

Start by cloning this repository.

We have set up docker-compose to start postgres and the unleash server together. This makes it really fast to start up unleash locally without setting up a database or node.

$ docker-compose build
$ docker-compose up

Requirements

We are using docker-compose version 3.9 and it requires:

• Docker engine 19.03.0+
• Docker compose 2.0.0+

For more info, check out the compatibility matrix on Docker's website: compatibility-matrix

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

Upgrade version

When we upgrade the unleash-version this project should be tagged with the same version number.

git tag -a v3.7.0 -m "upgrade to unleash-server v3.7.0"
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.