Documentation/Installing GitGov Desktop

Installing GitGov Desktop

The GitGov Desktop application is the foundational capture agent for the ecosystem. It runs in the background, monitoring your active Git operations and providing real-time feedback on policy compliance.

System Prerequisites

Before proceeding with the installation, ensure your workstation meets the following technical requirements:

  • Operating System: Windows 10 or 11 (64-bit).
  • Git Version: 2.30 or higher (must be in system PATH).
  • Permissions: Administrative rights for initial setup.
  • Memory: Minimum 2 GB RAM (GitGov uses ~50 MB when idle).

Acquisition & Deployment

1. Retrieve Installer

Navigate to the GitGov Download Portal and select the latest .exe package for Windows.

2. Execute Setup

Double-click the downloaded binary.

[!IMPORTANT] Security Notice: During the early access phase, the installer may trigger Windows SmartScreen. Click "More Info" followed by "Run Anyway" to proceed. Code signing certificates are in progress.

3. Installation Wizard

Follow the on-screen prompts. GitGov defaults to installing in %LOCALAPPDATA%\Programs\GitGov. Keep this default path to ensure automatic updates function correctly.


Post-Installation Setup

Once installed, GitGov will launch automatically. Complete the following steps to initialize the capture agent:

A. Git Detection

The app locates your git.exe from the system PATH. If Git is installed but not detected, verify that git --version works in a CMD or PowerShell terminal and that Git is present in your PATH environment variable.

B. Control Plane Connection

Provide the URL of your organization's Control Plane server. Your DevOps team will supply this address. The app connects automatically on launch — no manual action required once the URL is saved.


What GitGov Captures

Once connected, GitGov captures the following Git events automatically:

EventTrigger
stage_filesFiles added to the Git index (git add)
commitA new commit is created (includes SHA, message, author, branch)
attempt_pushA push is initiated
successful_pushPush completes successfully
blocked_pushPush rejected by branch protection policy
push_failedPush fails (network, remote rejection, etc.)

Note: For repositories with a very large number of staged files, the stage_files event captures a maximum of 500 file entries. A truncated flag is set in the event metadata when this limit is reached.


Operational Verification

To confirm the capture agent is functioning correctly, perform a "Canary Push":

  1. Open a terminal (PowerShell, Git Bash, or CMD).
  2. Navigate to a Git repository.
  3. Stage and commit a change: git add . && git commit -m "chore: test capture"
  4. Switch to the GitGov Desktop UI. You should see stage_files and commit events appear in the Live Events feed within milliseconds.

Troubleshooting Common Issues

IssuePotential CauseResolution
"Git not found"Git not in system PATHVerify git --version works in CMD/PS. Adjust PATH if needed.
Connection timeoutFirewall or VPN blocking port 3000Ensure outbound traffic to the Control Plane host on port 3000 is allowed.
Events not appearingControl Plane not runningVerify the server is active. Check the connection status indicator in the Desktop app.
SmartScreen warningNo code signing certificateClick "More Info" → "Run Anyway". This is expected during early access.

Next Phase

All rights reserved.© 2026 GitGov
Installing GitGov Desktop | GitGov