Sirius is an open-source general purpose vulnerability scanner that leverages community-driven security intelligence. Get started in minutes with our Docker-based setup.

For detailed setup instructions, visit our Installation Guide.

1. Prerequisites

   • Docker Engine 20.10.0+
   • Docker Compose V2
   • 4GB RAM minimum
   • 10GB free disk space

2. Installation

   # Clone the repository
   git clone git@github.com:SiriusScan/website.git
   cd website
   
   # Start all services
   docker compose up -d
   
   # Access the web interface
   open http://localhost:3000

3. Login

   • Username: admin
   • Password: password

That's it! Your Sirius Scan instance is now running. For a complete walkthrough of the system, visit our Quick Start Guide.

For a comprehensive walkthrough of all features, visit our Interface Tour.

The Dashboard serves as your central command center, providing:

• Real-time scanning activity and progress
• Latest vulnerability discoveries and trends
• System performance metrics
• Quick-access controls for common actions

Learn more about the Dashboard

The Scan page is where you control vulnerability assessments:

• Visual module editor for custom workflows
• Real-time scan progress monitoring
• Automated scanning schedules
• Fine-tuned scanning parameters
• Custom scan profiles and templates

Learn more about Scanning

Comprehensive platform for managing discovered vulnerabilities:

• Dynamic vulnerability listing with real-time updates
• Advanced search and filtering capabilities
• Multiple view options (list, grid, severity-based)
• Detailed vulnerability reports including:
  • CVE/CPE mapping
  • CVSS scoring breakdown
  • Step-by-step remediation instructions

Learn more about Vulnerability Management

Complete visibility into your infrastructure:

• Full host inventory management
• Risk scoring and security metrics
• Interactive network topology visualization
• Detailed system information
• Service enumeration and version tracking

Learn more about Environment Management

Detailed view of individual systems:

• Complete system specifications
• Port and service enumeration
• Vulnerability counts by severity
• Historical scan findings
• Security risk indicators

Learn more about Host Management

Direct access to Sirius backend:

• PowerShell environment for advanced operations
• Custom script execution
• Agent deployment and management
• System diagnostics
• Batch operations support

Learn more about Terminal Access

Sirius operates through several microservices:

For detailed configuration options, visit our Configuration Guide.

For complete development setup instructions, visit our Contributing Guide.

1. Configure Development Environment

   volumes:
     - ../minor-projects/go-api:/go-api
     - ../minor-projects/app-scanner:/app-scanner
     - ../minor-projects/app-terminal:/app-terminal
     - ../minor-projects/nmap-db:/nmap-db

2. Run Tests

   # Show test options
   ./run_tests.sh --help
   
   # Run all tests
   ./run_tests.sh --all
   
   # Run specific suites
   ./run_tests.sh --models  # Model tests
   ./run_tests.sh --ui      # UI tests

For API documentation and SDK usage, visit our API Documentation.

• REST API Reference
• Go SDK Documentation
• Error Handling

For detailed troubleshooting steps, visit our FAQ.

# Check all services
docker compose ps

# View logs
docker compose logs

# Check specific service
docker compose logs sirius-api

1. Service Fails to Start

   • Check logs: docker compose logs <service-name>
   • Verify ports: netstat -tuln
   • Check system resources

2. Database Connection Issues

   • Verify PostgreSQL: docker compose ps sirius-postgres
   • Check logs: docker compose logs sirius-postgres
   • Verify credentials

3. Message Queue Problems

   • Check RabbitMQ: http://localhost:15672
   • View logs: docker compose logs sirius-rabbitmq

For production deployments:

• Change all default credentials
• Secure your services
• Update environment variables
• Configure firewall rules

For detailed security best practices, visit our Security Guide.

• Documentation Home
• API Reference
• User Guides
• GitHub Issues
• Discord Community
• FAQ
• Contributing Guide

This project is licensed under the terms specified in the LICENSE file.

Note: For production deployments, ensure you change all default credentials and properly secure your services.