Skip to main content

Getting started

Let's discover Gitness in less than 30 seconds.

Install Gitness

Use the following Docker command to install Gitness.

docker run -d \
-p 3000:3000 \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /tmp/gitness:/data \
--name gitness \
--restart always \
  1. Once the container is running, open localhost:3000 in your browser.
  2. Select Sign Up.
  3. Enter a User ID, Email, and Password.
  4. Select Sign Up.

The Gitness image uses a volume to store the database and repositories. It is highly recommended to use a bind mount or named volume to ease managing the data on Gitness upgrades.

Learn how to configure Gitness for your use case.

Create a project

  1. Select New Project.
  2. Enter a project Name and optional Description.
  3. Select Create Project.

Optionally, Gitness can import projects from external sources (such as GitLab groups or GitHub organizations).

Create a repository

  1. In your project, select Repositories and then select New Repository.
  2. Enter the repository Name.
  3. Select Create Repository.

Optionally, Gitness can import repositories from external sources (such as GitLab or GitHub).

Work with Gitness

Now that you've created a project and repository, you can: