Documentation
Everything here reflects the repository as implemented — each page notes its source files, so staleness is detectable. Start with deployment, then follow your product.
Getting started
Clone, configure, and run your first scan with Docker Compose.
Configuration
The environment-variable reference — core, GitHub, database, scanning.
Scanning modes
Shallow vs. deep scans, flags, limits, and the repository cache.
Findings & workflow
The 21-state lifecycle, approval gates, ownership, and SLAs.
Validation
Live provider checks, correlation, categories, and outcomes.
Privacy scanning
Presidio, recognizer packs, documents, OCR, and compliance mapping.
AI Guardienne
Build, load, and configure the offline browser extension.
CLI
The pre-commit scanner: commands, exit codes, and .periscope.yaml.
API reference
REST endpoints, the response envelope, and authentication.
WebSocket events
The real-time event stream and log replay fallback.
Governance sync
SimpleRisk and CISO Assistant providers, worker deployment.
Deployment
Docker topology, PostgreSQL, production guard, and SARIF in CI.
Security model
Encryption, audited reveal, RBAC, and hardening defaults.
DNS change runbook
Required post-change checks for routing, TLS, mail auth, verification records, and transactional email.
Transactional email delivery
Provider-based sending, SPF/DKIM/DMARC, bounce monitoring, and major-mailbox delivery tests.
Monitoring & alerting
Real-time monitoring, alerting rules, and incident response procedures.
Disaster recovery & failover
RTO/RPO targets, the failover procedure, and how recovery is tested.
Site recovery & backups
Where source, content, infra, and assets live so the public site can be rebuilt without production.
Secrets: leak prevention & rotation
Secret manager only, scoped credentials, scan coverage, and the revocation runbook.
Dependency & patch automation
Automated update PRs, continuous SCA scanning, and remediation SLAs.