Skip to main content
Installation Guide

Install the HAIEC GitHub App

Connect your GitHub repositories to HAIEC in under 3 minutes. No code changes, no CI/CD modifications, no configuration files.

Estimated time: 3 minutes

Before You Start

You Need

  • Admin access to your GitHub organization or personal account
  • A HAIEC account (free tier works)

You Do NOT Need

  • Programming knowledge
  • CI/CD pipeline changes
  • Configuration files in your repo

Step-by-Step Installation

1

Sign in to HAIEC

Go to haiec.com/login and sign in. If you do not have an account, create one first.

Sign in before installing the GitHub App. This ensures your installation is automatically linked to your HAIEC account.

2

Go to GitHub App Installation

Navigate to your HAIEC Dashboard → GitHub section and click "Install GitHub App". You will be redirected to GitHub.

Or go directly to: https://github.com/apps/haiec-compliance/installations/new

3

Choose Where to Install

GitHub will ask you to select an account or organization:

Personal Account

Select your username. Good for personal projects and testing.

Organization

Select your org name. Requires admin permissions. Recommended for teams.

4

Select Repositories

All Repositories (Recommended)

HAIEC can scan any current and future repository. Easiest to manage.

Select Repositories

Choose specific repos. More control, but requires manual updates when adding new repos.

5

Confirm Permissions & Install

GitHub will show the permissions HAIEC requests. Review and click "Install".

PermissionLevelWhy
ContentsReadScan code for security vulnerabilities (diff/full mode)
MetadataReadDetect governance controls (branch protection, CI, policies)
Pull RequestsRead + WritePost PR comments with findings and readiness scores

HAIEC does not request write access to code, secrets, or environment variables. Your code is read temporarily and never stored.

6

Link Your GitHub Account (OAuth)

After installation, you will be redirected back to HAIEC. If prompted, click "Connect via GitHub OAuth" to link your GitHub account to your HAIEC account.

This step is required so your installations appear in your HAIEC dashboard. Without OAuth linking, the dashboard cannot match your GitHub installations to your HAIEC account.

7

Configure Scan Mode (Optional)

By default, the app starts in Metadata mode (free). To enable code analysis:

  1. Go to HAIEC Dashboard → GitHub
  2. Find your installation and click "Scan Settings"
  3. Select your scan mode: Metadata, Diff, or Full
  4. Click "Save Settings"
Metadata
Free
Diff Analysis
Starter+
Full Repo
Pro+

Verify Your Installation

Quick Test

  1. Go to one of your installed repositories on GitHub
  2. Create a new branch and make any change
  3. Open a Pull Request
  4. Within 30 seconds, HAIEC should post a PR comment with:
    • Readiness score (0-100%)
    • Control signal breakdown (which files/settings were detected)
    • Trust artifact badge

Troubleshooting

I do not see my repositories in the HAIEC dashboard

Make sure you have linked your GitHub account via OAuth. Go to Dashboard → Settings → GitHub and click "Connect via OAuth". Then refresh the GitHub dashboard page.

No PR comment appeared after opening a PR

Check that the GitHub App is still installed on the repository. Go to GitHub → Settings → Applications → Installed GitHub Apps → HAIEC. Also verify the webhook URL is correct in your GitHub App settings.

I see "Authentication Failed" when redirected after installation

This happens if you were not signed in to HAIEC before installing. Sign in at haiec.com/login, then go to your HAIEC dashboard. Your installation should appear after OAuth linking.

Diff or Full mode is not working

Verify your subscription tier supports the selected mode (Starter+ for Diff, Pro+ for Full). Check that you have not exceeded your monthly PR analysis limit.

Can I remove HAIEC later?

Yes. Go to GitHub → Settings → Applications → Installed GitHub Apps → HAIEC → Uninstall. This immediately revokes all access. No data is retained.

Can I change which repositories HAIEC can access?

Yes. Go to GitHub → Settings → Applications → Installed GitHub Apps → HAIEC → Configure. You can add or remove repositories at any time.

Uninstallation & Data

How to Uninstall

  1. Go to GitHub → Settings → Applications
  2. Find "HAIEC" under Installed GitHub Apps
  3. Click "Configure" → "Uninstall"
  4. Confirm the uninstallation

Uninstallation is immediate. HAIEC loses all access to your repositories instantly.

What Happens to Your Data

  • Source code was never stored — nothing to delete
  • PR comments remain on GitHub (you can delete them manually)
  • Trust artifacts and readiness scores are retained in your HAIEC account for audit trail purposes
  • To delete all HAIEC data, contact support@haiec.com or use the data deletion request process

Ready to Install?

Connect your repositories and start collecting governance signals in under 3 minutes.