Appearance
Quick Start
Get Vulcan up and running in minutes with Docker.
Prerequisites
- Docker and Docker Compose installed
- 4GB+ RAM available
- Port 3000 available
Quick Installation
1. Pull and Run with Docker
bash
# Pull the latest released image
docker pull mitre/vulcan:release-latest
# Or use docker compose for a complete setup
wget https://raw.githubusercontent.com/mitre/vulcan/master/docker-compose.yml
wget https://raw.githubusercontent.com/mitre/vulcan/master/setup-docker-secrets.sh
chmod +x setup-docker-secrets.sh
./setup-docker-secrets.sh
docker compose up2. Access Vulcan
Open your browser and navigate to: http://localhost:3000
The first user to register becomes admin automatically.
Admin Bootstrap
For automated deployments, you can pre-configure an admin account via environment variables (VULCAN_ADMIN_EMAIL and VULCAN_ADMIN_PASSWORD). See Environment Variables for details.
3. First Steps
- Create a Project: Click "New Project" to start organizing your security controls
- Import an SRG: Upload a Security Requirements Guide to begin tailoring
- Create a Component: Click "New Component" → "Create New Component". The form first asks What are you authoring? — STIG (implement an SRG's requirements for a specific product) or SRG (author a new Security Requirements Guide derived from core SRGs). The choice is permanent for the component.
- Write Controls: Begin documenting security controls with both human-readable guidance and InSpec validation code — or, for an SRG component, decide and tailor each requirement (see the SRG Authoring Workflow)
Next Steps
- Full Installation Guide - Production deployment options
- Configuration Guide - Authentication, email, and advanced settings
- User Guide - Complete walkthrough of Vulcan features
Getting Help
- Issues: GitHub Issues
- Discussions: GitHub Discussions
- Email: saf@mitre.org