Welcome to the Sirius Scan installation guide. Sirius is an open-source general purpose vulnerability scanner that leverages community-driven security intelligence, combining vulnerability databases, network scanning, agent-based discovery, and custom assessor analysis.
Before installing Sirius Scan, ensure your system meets the following requirements:
Sirius consists of several microservices:
git clone https://github.com/SiriusScan/Sirius.git
cd Sirius
docker compose up -d
This command downloads pre-built Docker images and starts all services automatically.
admin
password
Check if all services are running:
docker compose ps
Verify UI accessibility:
curl -s -o /dev/null -w "%{http_code}" http://localhost:3000
# Should return: 200
✅ If everything is working, you can proceed to the Quick Start Guide!
Most users won't need this section. These steps are only necessary if you experience problems during installation.
The following issues can occur when Docker images aren't available on the registry or when there are local environment conflicts:
Problem: docker compose up -d
fails with "pull access denied" or "image not found" errors.
Why this happens: Sometimes pre-built images aren't available on the registry, or you're using an older version that requires local building.
Solution: Build the images locally instead:
docker compose build --no-cache
docker compose up -d
Problem: Build process fails with compilation errors (bcrypt, dependency installation, etc.).
Why this happens: Local system differences, Docker cache issues, or missing dependencies.
Solution: Clean Docker cache and rebuild:
docker compose down
docker system prune -f
docker compose build --no-cache
docker compose up -d
Problem: Services fail to start or keep restarting.
Why this happens: Port conflicts, insufficient resources, or configuration issues.
Solutions:
docker compose logs <service-name>
netstat -tuln
When to use: If you have persistent issues and want to start completely fresh.
# Stop all services
docker compose down
# Remove all containers and volumes
docker compose down --volumes --remove-orphans
# Clean Docker system
docker system prune -f
# Start fresh
docker compose up -d
# Monitor startup
docker compose logs -f
If you continue to experience issues:
Important: For production deployments, ensure you: