{"id":13845831,"url":"https://github.com/scoringengine/scoringengine","last_synced_at":"2026-02-07T06:00:50.121Z","repository":{"id":33555739,"uuid":"71934380","full_name":"scoringengine/scoringengine","owner":"scoringengine","description":"Scoring Engine for Red/White/Blue Team Competitions","archived":false,"fork":false,"pushed_at":"2026-02-01T20:18:23.000Z","size":7494,"stargazers_count":134,"open_issues_count":107,"forks_count":55,"subscribers_count":11,"default_branch":"master","last_synced_at":"2026-02-02T01:30:25.839Z","etag":null,"topics":["ccdc","python","scoring-engine"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scoringengine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2016-10-25T20:05:11.000Z","updated_at":"2026-02-01T18:24:40.000Z","dependencies_parsed_at":"2023-10-15T16:50:43.002Z","dependency_job_id":"c8051f7f-1bbe-42cd-ae73-13856416c84c","html_url":"https://github.com/scoringengine/scoringengine","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/scoringengine/scoringengine","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scoringengine%2Fscoringengine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scoringengine%2Fscoringengine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scoringengine%2Fscoringengine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scoringengine%2Fscoringengine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scoringengine","download_url":"https://codeload.github.com/scoringengine/scoringengine/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scoringengine%2Fscoringengine/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29187931,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-07T05:07:31.176Z","status":"ssl_error","status_checked_at":"2026-02-07T05:06:15.227Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ccdc","python","scoring-engine"],"created_at":"2024-08-04T17:03:37.677Z","updated_at":"2026-02-07T06:00:50.114Z","avatar_url":"https://github.com/scoringengine.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"[![Documentation Status](https://readthedocs.org/projects/scoringengine/badge/?version=latest)](https://scoringengine.readthedocs.io/en/latest/)\n[![CI](https://github.com/scoringengine/scoringengine/actions/workflows/tests.yml/badge.svg)](https://github.com/scoringengine/scoringengine/actions/workflows/tests.yml)\n[![Coverage Status](https://coveralls.io/repos/github/scoringengine/scoringengine/badge.svg?branch=master)](https://coveralls.io/github/scoringengine/scoringengine?branch=master)\n\n# Scoring Engine\n\nScoring Engine is an open-source platform for running Red/White/Blue team cybersecurity competitions. It automates service checks each round and provides a web-based scoreboard and configuration interface.\n\n![Scoring Engine screenshot](https://github.com/scoringengine/scoringengine/blob/master/docs/source/images/screenshots.gif)\n\n## Features\n\n- Automated scheduling and execution of service checks\n- Distributed parallel execution via Celery workers and Redis\n- Web interface for viewing scores and configuring services\n- JSON API for programmatic access to scores and configuration\n- 28 built-in service checks (SSH, HTTP, DNS, SMTP, and more)\n- Support for airgapped/offline deployments\n- Example mode with pre-populated demo data\n\n## Architecture\n\nScoring Engine uses a distributed architecture with the following components:\n\n| Component | Technology | Purpose |\n|-----------|------------|---------|\n| Web UI | Flask | Scoreboard, team management, administration |\n| Task Queue | Celery | Distributed job scheduling and execution |\n| Message Broker | Redis | Task queue backend and caching |\n| Database | MySQL/MariaDB | Persistent storage for teams, services, and results |\n| Reverse Proxy | Nginx | HTTP server and load balancing |\n\n## Supported Service Checks\n\nScoring Engine includes checks for common services out of the box:\n\n| Category | Services |\n|----------|----------|\n| Network | ICMP, DNS, NFS |\n| Web | HTTP, HTTPS, Elasticsearch, WordPress |\n| Authentication | SSH, Telnet, LDAP, WinRM |\n| File Transfer | FTP, SMB |\n| Email | SMTP, SMTPS, IMAP, IMAPS, POP3, POP3S |\n| Database | MySQL, PostgreSQL, MSSQL |\n| Remote Desktop | RDP, VNC |\n| VPN | OpenVPN |\n\nCustom checks can be added by creating a Python class in `scoring_engine/checks/`.\n\n## Prerequisites\n\n### Docker Installation (Recommended)\n\n- [Docker](https://www.docker.com/products/overview)\n- [Docker Compose](https://docs.docker.com/compose/) (included with Docker Desktop; on Linux install separately)\n- For Windows users, ensure Docker Desktop is set to [use Linux containers](https://docs.docker.com/docker-for-windows/#switch-between-windows-and-linux-containers).\n\n### Source Installation\n\nFor installing from source without Docker:\n\n- **Python 3.10 or higher** is required\n- MariaDB/MySQL database server\n- Redis server\n\n```bash\n# Install the package\npip install -e .\n\n# Or install with test dependencies\npip install -e .\npip install -r tests/requirements.txt\n```\n\n## Quick Start\n\nBuild and start all services:\n\n```bash\ndocker compose build\ndocker compose up\n```\n\nOr use the Makefile for convenience:\n\n```bash\nmake build\nmake run\n```\n\nOnce running, access the application at [http://localhost](http://localhost/).\n\n### Demo Credentials\n\nLog in using any of the following credentials:\n\n| Username | Password | Role |\n|----------|----------|------|\n| `whiteteamuser` | `testpass` | White Team (Admin) |\n| `team1user1` | `testpass` | Blue Team 1 |\n| `team2user1` | `testpass` | Blue Team 2 |\n| `team2user2` | `testpass` | Blue Team 2 |\n| `redteamuser` | `testpass` | Red Team |\n\n### Environment Variables\n\nReset the database before starting:\n\n```bash\nSCORINGENGINE_OVERWRITE_DB=true docker compose up\n```\n\nRun with sample data (demo mode):\n\n```bash\nSCORINGENGINE_EXAMPLE=true docker compose up\n```\n\nOr combine both for a fresh demo:\n\n```bash\nmake run-demo\n```\n\n## Pre-built Docker Images\n\nPre-built images are available from both registries:\n\n- **GitHub Container Registry**: `ghcr.io/scoringengine/scoringengine/\u003cimage\u003e:\u003ctag\u003e`\n- **Docker Hub**: `scoringengine/\u003cimage\u003e:\u003ctag\u003e`\n\nAvailable images: `base`, `bootstrap`, `engine`, `web`, `worker`\n\nTags: `latest`, `develop`, version tags (e.g., `v1.1.0`)\n\n## Airgapped Deployments\n\nFor competitions with no internet access:\n\n```bash\n# Create a complete deployment package\n./bin/create-airgapped-package.sh\n\n# Transfer scoringengine-airgapped.tar.gz to the airgapped system\n# Then extract and deploy:\ntar -xzf scoringengine-airgapped.tar.gz\ncd scoringengine-airgapped\n./deploy.sh\n```\n\nSee the [Airgapped Deployment Guide](docs/source/installation/airgapped.rst) for detailed instructions.\n\n## Development\n\n### Makefile Commands\n\n| Command | Description |\n|---------|-------------|\n| `make build` | Build all Docker images |\n| `make run` | Start all services |\n| `make run-demo` | Start with demo data (resets database) |\n| `make stop` | Stop all services |\n| `make clean` | Stop services and remove volumes |\n| `make rebuild-new` | Full rebuild with fresh database |\n| `make run-tests` | Run unit tests with coverage |\n| `make build-integration` | Build integration test environment |\n| `make run-integration-tests` | Run integration tests |\n\n### Running Tests\n\nRun the linters and test suite before submitting changes:\n\n```bash\n# Install pre-commit hooks\npip install pre-commit\npre-commit install\n\n# Run linters on changed files\npre-commit run --files \u003cchanged-files\u003e\n\n# Run all tests\npytest tests/\n\n# Run tests with coverage\nmake run-tests\n```\n\nTo check all files: `pre-commit run --all-files`\n\n### Building Documentation Locally\n\n```bash\npip install -r docs/requirements.txt\ncd docs\nmake html\n```\n\nOpen `docs/build/html/index.html` in your browser.\n\n## Version Management\n\nThis project uses semantic versioning. To bump versions:\n\n```bash\n# Install development dependencies\npip install -r tests/requirements.txt\n\n# Bump version (patch/minor/major)\nbump-my-version bump patch\n```\n\nSee [VERSION_MANAGEMENT.md](VERSION_MANAGEMENT.md) for detailed instructions.\n\n## Documentation\n\nFull documentation is available at [https://scoringengine.readthedocs.io/en/latest/](https://scoringengine.readthedocs.io/en/latest/).\n\n## License\n\nReleased under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscoringengine%2Fscoringengine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscoringengine%2Fscoringengine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscoringengine%2Fscoringengine/lists"}