ArchGuard Help

Guides for connecting Bitbucket, understanding pull request checks, managing guardrails and approving ADRs.

Getting started
What ArchGuard does and the fastest path from install to your first gated pull request.
Local setup
Run ArchGuard on your machine with Docker Compose, the web app and the worker.
Cloud deployment (Hetzner example)
Host ArchGuard on a single cloud server with HTTPS, using Hetzner Cloud as a worked example.
Connect Bitbucket Cloud
Create a Workspace Access Token, choose its scopes, and connect it under Settings.
Connect GitHub
Create a fine-grained personal access token, connect GitHub.com under Settings, and require the ArchGuard check.
Enable repositories and webhooks
Turn ArchGuard on for a repository, set its triggers and ADR folder.
How evaluation works
The steps ArchGuard takes for each pull request, from webhook to result.
Build statuses and PR comments
What the ArchGuard check and the pull request comment mean, including neutral and too-large results.
Guardrail rules
The five starter rules, and how Architects create, tune and disable rules.
Review and commit ADRs
How ADR drafts are created, edited, approved and committed to your repository.
Roles and permissions
What Admins, Architects and Viewers can do, and how roles come from your identity provider.
Using the dashboard
Compliance rates, drift alerts, pending ADR drafts and the approved ADR timeline.
Pilot mode and shadow mode
Roll out gradually with ENTERPRISE_PILOT_MODE and without blocking merges for the first week.
Security and data handling
How ArchGuard protects source code, credentials and tenant data.
Troubleshooting and FAQ
Fixes for common problems, and answers to frequent questions.