Installation Guide
This guide covers installing all DevGuard components:
- DevGuard Scanner - CLI tool for security scanning
- DevGuard CLI - Management tool for advanced operations
- DevGuard Platform - Backend API and web UI (self-hosted)
DevGuard Scanner
The scanner is the primary tool for running security scans. It's a standalone binary with no dependencies.
System Requirements
- OS: Linux (x86_64, arm64), macOS (Intel, Apple Silicon), Windows (x86_64)
- Network: Access to your used DevGuard Instance
Installation Methods
Go Install (Recommended)
Requires Go 1.21 or later.
Verify installation:
DevGuard CLI
The CLI tool provides additional management capabilities for vulnerability databases, licenses, and advanced operations.
DevGuard Platform (Self-Hosted)
The platform provides centralized vulnerability management, web UI, and API.
Prerequisites
- A Kuberntes Cluster or Docker and Docker Compose
- About 2GB+ RAM
- About 20GB+ disk space
Deployment Options
See the Helm Deployment Guide for Kubernetes installation instructions.
Versioning and Compatibility
All DevGuard components share the same minor version. Any vX.Y.* release of one component is compatible with any vX.Y.* release of any other component. Patch versions are released independently — you can upgrade one component without upgrading others, as long as the minor version matches.
| Component | Compatible example |
|---|---|
| DevGuard (API/backend) | v1.7.5 |
| DevGuard Web (frontend) | v1.7.2 |
| Helm chart | v1.7.0 |
All three above are compatible — they share minor version 1.7.
See the full Versioning Policy for details. For a full history of changes see the DevGuard CHANGELOG and the Helm Chart CHANGELOG.
Next Steps
- Quick Start Guide - Run your first scan
- Core Concepts - Understand DevGuard architecture