System documentation

Protect every change before it ships.

SecureFlow is the security barrier around your GitHub workflow. It scans pull requests, catches exposed secrets, and gives teams a clear decision before code reaches production.

01 / First contact

Getting Started

SecureFlow works with a GitHub App and a PostgreSQL-backed workspace. Setup takes three steps:

01

Configure

Add the GitHub App and OAuth credentials to your environment.

02

Install

Install SecureFlow on the repositories you want to protect.

03

Open a PR

Create a pull request and let the scanner report its verdict.

npm install
cp .env.example .env
npm run db:migrate
npm run dev

02 / Perimeter

Security Overview

SecureFlow turns security checks into an auditable decision system rather than a last-minute review.

Secret detection

Finds API keys, tokens, credentials, and high-confidence leaked material before merge.

Policy gates

Map severity to pass, review, or blocked states with rules your team controls.

Auditable actions

Records security decisions and workflow events for investigation and compliance.

Defense in depth

Combines signatures, context-aware analysis, GitHub checks, and protected webhooks.

03 / The watcher

PR & Secret Scanning

Every pull request is evaluated as a change set. SecureFlow inspects the diff, classifies findings, and reports the result back to GitHub.

  • Hardcoded credentials and provider tokens
  • Vulnerability signatures and risky patterns
  • Changed files and pull request context
  • Severity-aware remediation guidance
Findings are redacted and minimized before they are persisted or shown to users.

04 / The pipeline

CI/CD Integration

GitHub webhooks acknowledge quickly, then queue scan work for asynchronous processing. This keeps the provider callback reliable while the deeper scan runs.

01

Pull request

02

Webhook

03

Scan queue

04

GitHub verdict

Use the repository status check as a merge gate in your protected branch rules.

05 / Identity

Authentication

Sign in with GitHub using OAuth. SecureFlow creates or retrieves your account, assigns the standard user role, encrypts the session as a JWT, and redirects you to the dashboard.

Required environment

GITHUB_CLIENT_ID · GITHUB_CLIENT_SECRET · AUTH_SECRET · DATABASE_URL

06 / Response

Security Alerts

Alerts surface findings where developers already work. A finding includes its severity, file context, policy decision, and suggested next action.

CRITICALHIGHMEDIUMLOW

07 / Mission control

Dashboard

The dashboard is the operational view for your workspace. Review active findings, scan status, repository coverage, policy outcomes, and the audit trail from one place.

Analytics

Track trends and scan performance.

Findings

Prioritize what needs attention.

Audit

Inspect security decisions.

08 / Team signal

Leaderboard

The leaderboard turns secure engineering into a visible team signal. It highlights contributors by reviewed and resolved security work without exposing sensitive finding content.

View leaderboard

09 / Quick answers

FAQ

Does SecureFlow block every pull request?

No. Policy thresholds decide what passes, needs review, or is blocked. Teams can tune those policies in the dashboard.

Where are secrets stored?

Findings are minimized and redacted. OAuth credentials and application secrets stay in server-side environment variables.

Can I scan private repositories?

Yes. Install the GitHub App only on the repositories and organizations you authorize.

What happens when the scanner is busy?

The webhook is acknowledged and the scan is placed on a queue, so GitHub does not have to wait for the full analysis.