Scoring Engine is an open-source platform for running Red/White/Blue team competitions. It automates service checks each round and provides a web-based scoreboard and configuration interface.
- Automated scheduling and execution of service checks
- Redis-backed workers for parallel execution
- Web interface for viewing scores and configuring services
- JSON API for programmatic access to scores and configuration
- Example mode with pre-populated demo data
- Docker
- Docker Compose (included with Docker Desktop; on Linux install separately)
- For Windows users, ensure Docker Desktop is set to use Linux containers.
From this directory run:
docker-compose build
docker-compose up
Reset the database before starting:
SCORINGENGINE_OVERWRITE_DB=true docker-compose up
Run with sample data and only the web UI:
SCORINGENGINE_EXAMPLE=true docker-compose up
Once running, access the application at http://localhost.
Log in using any of the following credentials:
whiteteamuser:testpass
team1user1:testpass
team2user1:testpass
team2user2:testpass
redteamuser:testpass
Full documentation is available at https://scoringengine.readthedocs.io/en/latest/.
To build the documentation locally:
pip install -r docs/requirements.txt
cd docs
make html
Open docs/build/html/index.html
in your browser to view the rendered documentation.
Run the linters and test suite before submitting changes:
pre-commit run --files <changed-files>
pytest
To check every file, use pre-commit run --all-files
.
Released under the MIT License.