knsit/gitpitch repository overview

⁠GitPitch Container

It's recommended to run the container with docker-compose because there are a few environment variables and it's easier to configure them all in one docker-compose.yml than passing them all in one docker run statement.

But if you want to, you could run the container like this:

docker run -d --rm --name gitpitch -e GP_GITHUB_AS_DEFAULT=true -p 9000:9000 knsit/gitpitch

This starts the container, enables the GitHub service and sets it as default.

To start the container and configure it for GitLab the call would look like this:

docker run -d --rm --name gitpitch -e GP_GITLAB_BASE=https://gitlab.com/ -e GP_GITLAB_API=https://gitlab.com/api/v4/ -e GP_GITLAB_AS_DEFAULT=true -p 9000:9000 knsit/gitpitch

This configuration enables the GitLab service and configures it for public repositories only. If you want to access private repositories you'll need a private token.

All other providers are configured equivalently. Have a look at the following section containing all available environment variables.

⁠Environment Variables

⁠Common

⁠GitHub

⁠GitLab

⁠Bitbucket

⁠Gitea

⁠Gogs

⁠GitBucket

⁠Docker-Compose

As already mentioned it's much easier to run the configuration with docker-compose. The equivalent to the docker run call above could look like this:

version: '3'
services:
  gitpitch:
    image: knsit/gitpitch:latest
    environment:
      - "GP_GITLAB_BASE=https://gitlab.com/"
      - "GP_GITLAB_API=https://gitlab.com/api/v4/"
      - "GP_GITLAB_AS_DEFAULT=true"
    ports:
      - 9000:9000