Docker is used to distribute the Headbase server for self-hosting.
The docker image is published to the Github Container Registry and can be pulled like so:
docker pull ghcr.io/headbase-app/server
You can then run that image, however remember:
- You must supply all environment variables as defined in
packages/server/.env.example
. - You will need to expose the port which matches the
PORT
environment variable you define, for example-p 8080:8080
.
The headbase-app/server
docker image is automatically created and published via GitHub actions when a tag with the pattern server/**
is created or pushed.
To manually create a docker image locally for testing you can do:
docker build . --tag headbase-server
docker run headbase-server -p 8080:8080