Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (51 loc) · 3.35 KB

CONTRIBUTING.md

File metadata and controls

77 lines (51 loc) · 3.35 KB
Raw

Contributing to Sentinel

Thanks for your interest in Sentinel by SourceBox. This document explains how you can help, and what we accept.

We do not currently accept external code contributions

Sentinel is source-available under AGPL-3.0. The source is public for trust and transparency — customers can audit the implementation behind every security and privacy claim on the live site — but we do not accept pull requests from outside the core team at this time. Command Center is a SaaS we host and operate; running your own copy is allowed by the license but is not the intended use case.

External pull requests opened against this repository will be automatically closed with a link back to this document. This is not personal — we keep the contribution surface narrow so we can move fast, retain clean copyright, and avoid the overhead of a Contributor License Agreement.

What we do welcome

Channel What to use it for
Issues Bug reports, reproducible problems, security disclosures
Discussions Feature ideas, questions about how the platform works
Forks Audit, study, and private modifications under AGPL-3.0 (see the license for your §13 network-use obligations if you redistribute or run a modified network-accessible copy)

A clear bug report with steps to reproduce is genuinely valuable — please open one if you hit something broken.

Reporting bugs

Before filing, check existing issues. Include:

  • Steps to reproduce
  • Expected vs. actual behavior
  • Relevant logs (redact any secrets)
  • Environment (OS, Python version, browser if UI-related)

Reporting security issues

See SECURITY.md. Do not file public issues for vulnerabilities.

Local development setup

For engineers cloning the repo to read, audit, or contribute fixes locally. (Most end users sign up at the live SaaS rather than running Command Center themselves — but self-hosting via AUTH_PROVIDER=local is a supported mode, not just a dev-only setup; see AGENTS.md › Build & Run.)

Sentinel has two main components:

Component Language Repository
Command Center Python (FastAPI) + React Sentinel-Command
CameraNode Rust Sentinel-CameraNode

Command Center

# Backend
cd backend
cp .env.example .env
uv sync
uv run python start.py       # http://localhost:8000

# Frontend
cd frontend
cp .env.example .env
npm install
npm run dev                   # http://localhost:5173

CameraNode

cd Sentinel-CameraNode
cargo build --release
./target/release/sourcebox-sentry-cameranode setup

See the CameraNode README for full setup instructions.

License

Sentinel Command Center is licensed under AGPL-3.0. AGPL §13 obligates anyone who modifies the code and offers a network-accessible version of it to publish their changes. Read the license before redistributing or running a modified copy.

Thank you for your interest in Sentinel by SourceBox.