GitOps
Docs Getting Started Installation

Installation

GitOps is distributed as a Docker image. The container listens on port 3000 and reads its configuration from environment variables.

Requirements

  • Docker Engine 20.10 or later
  • A GitHub, GitLab, or Bitbucket account
  • A repository access token with read and write permission for the GitDB repository

Docker image

The image is published to GitHub Container Registry:

docker pull ghcr.io/getgitops/gitops:latest

latest points to the newest published image. You can also review the latest release, browse all releases, or visit the GitOps repository.

Repository access token

GitOps uses GITDB_USERNAME and GITDB_TOKEN to authenticate with the repository configured in GITDB_REPOSITORY_URL. GitOps reads and pushes GitDB changes, so the token must have repository read and write permission.

GitHub fine-grained token
  1. Open GitHub Settings, then Developer settings and Personal access tokens.
  2. Create a fine-grained token and select only the GitDB repository.
  3. Grant Contents: Read and write, then generate and copy the token.

Use x-access-token as GITDB_USERNAME.

Run GitOps

Create a .env file with the values described in the configuration reference, then start the container:

docker run -d 
  --name gitops 
  --restart unless-stopped 
  --env-file .env 
  -p 3000:3000 
	ghcr.io/getgitops/gitops:latest

Open http://localhost:3000 when the container is ready. Check the logs with docker logs -f gitops.

Previous Introduction