SIRIUS

SCAN

Documentation

Installing Sirius Scan

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.

System Requirements

Before installing Sirius Scan, ensure your system meets the following requirements:

  • Docker Engine: Version 20.10.0 or newer with Docker Compose V2
  • System Requirements: 4GB RAM minimum, 10GB free disk space
  • Network Access: Internet connectivity for vulnerability database updates
  • Supported Platforms: Linux, macOS, Windows (with WSL2)
  • Git: Latest stable version recommended

System Architecture

Sirius consists of several microservices:

  • sirius-ui: Web interface (Next.js) running on port 3000
  • sirius-api: Backend API service on port 9001
  • sirius-engine: Scanning engine on port 5174
  • sirius-rabbitmq: Message broker (RabbitMQ) on ports 5672/15672
  • sirius-postgres: Database (PostgreSQL) on port 5432
  • sirius-valkey: Key-value store on port 6379

Installation Options

Sirius Scan offers two deployment modes to suit different use cases:

The default configuration provides a production-ready scanning environment:

git clone https://github.com/SiriusScan/Sirius.git
cd Sirius
docker compose up -d

This provides:

  • ✅ Complete scanning capabilities out-of-the-box
  • ✅ Pre-configured vulnerability databases
  • ✅ No additional setup required
  • ✅ Production-ready security scanning
  • ✅ Optimized performance

⚠️ Security Notice: For production deployments, change default credentials immediately.

Option 2: Development Mode (For Contributors)

For active development with hot-reloading and debugging tools:

git clone https://github.com/SiriusScan/Sirius.git
cd Sirius
docker compose -f docker-compose.dev.yaml up -d

This includes:

  • ✅ Volume mounts for live code changes
  • ✅ Hot-reloading for frontend (Next.js) and backend (Air)
  • ✅ Development debugging tools
  • ✅ Detailed logging for troubleshooting

Note: Development mode is designed for contributors. Most users should use Standard Mode.

Access the Web Interface

After starting the services:

  • Open http://localhost:3000 in your browser
  • Login with default credentials:
    • Username: admin
    • Password: password

Sirius Scan Login Page

Verifying Installation

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!

⚠️ Troubleshooting (Only if you encounter issues)

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:

Docker Image Issues

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

Container Build Failures

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

Service Startup Issues

Problem: Services fail to start or keep restarting.

Why this happens: Port conflicts, insufficient resources, or configuration issues.

Solutions:

  • Check service logs: docker compose logs <service-name>
  • Verify port availability: netstat -tuln
  • Ensure sufficient system resources (8GB+ RAM recommended)
  • Wait for database initialization (may take 30-60 seconds)

Complete Reset Procedure

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

Getting Help

If you continue to experience issues:

  1. Check GitHub Issues for similar problems
  2. Review the main repository documentation
  3. Open a new issue with detailed error logs
  4. Join our community discussions

Security Notice

Important: For production deployments, ensure you:

  • Change all default credentials immediately
  • Properly secure your services with firewalls
  • Review and update environment variables
  • Configure appropriate network access controls
  • Regularly update to latest versions

Next Steps

Next
Quick Start