Skip to Content
Developer GuideOverview

Developer Guide

ClearSight is open-source and self-hostable. This guide covers everything from spinning up a local instance to contributing custom scan engines.

Self-Hosting
Run ClearSight on your own infrastructure with Docker.
Architecture
Crawlers, BullMQ queues, scan pipeline, and data model.
API Reference
REST API for sites, crawls, scans, issues, and pages.
Contributing
Set up a dev environment and add features.
Last updated on
TroubleshootingPrerequisites