Skip to main content

Configuration

Variables​

Your Gitness instance can be configured by setting environment variables.

This command will start Gitness and enable the Admin user account with a preconfigured password, with user registration disabled.

docker run -d \
  -e GITNESS_PRINCIPAL_ADMIN_PASSWORD=correct-horse-battery-staple \
  -e GITNESS_USER_SIGNUP_ENABLED=false \
  -p 3000:3000 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /tmp/gitness:/data \
  --name gitness \
  --restart always \
  harness/gitness

All user accounts would be created manually by the Admin user.

Data​

Gitness writes data beneath /data within the running container.

It is highly recommended to use a bind mount or named volume to avoid potential data loss during system upgrades or reboots.

For example, on MacOS or Linux, create a gitness directory in a safe location:

mkdir $HOME/gitness

Then replace -v /tmp/gitness:/data with -v $HOME/gitness:/data in your docker run command.

Gitness will now store its data beneath the gitness directory in your home directory.