# HenKaiPan Docs

> Curated index of HenKaiPan documentation for LLMs and agents. Each link points to a clean markdown version of the page.

## Self-Hosted
- [Quickstart](/docs/quickstart.md): Install and run HenKaiPan with Docker Compose or Kubernetes, plus configuration and AI provider setup.
- [Kubernetes Deployment](/docs/kubernetes.md): Production Kubernetes deployment using the all-in-one manifest.
- [Backup & Restore](/docs/backup.md): Backup and restore procedures for the HenKaiPan PostgreSQL database.
- [Production Deployment](/docs/production.md): Production hardening checklist: TLS, security, environment configuration, backups and monitoring.
- [Operations Guide](/docs/operations.md): Operational guidance for worker scaling, scanner requirements and routine maintenance.
- [SSO with Authelia](/docs/sso-authelia.md): Configure OIDC single sign-on with Authelia, including a Docker Compose walkthrough.

## CI/CD
- [GitHub Actions](/docs/github-actions.md): Connect HenKaiPan security scans to a GitHub Actions pipeline.
- [GitLab CI](/docs/gitlab-ci.md): Connect HenKaiPan security scans to a GitLab CI pipeline.
- [Jenkins](/docs/jenkins.md): Connect HenKaiPan security scans to a Jenkins pipeline.
- [CircleCI](/docs/circleci.md): Connect HenKaiPan security scans to a CircleCI pipeline.
- [Docker](/docs/docker.md): Run HenKaiPan scans from a Docker-based CI job.
- [CI/CD Quickstart](/docs/ci-cd-quickstart.md): Quick reference for triggering HenKaiPan scans from external CI/CD.
- [HenKaiPan CLI](/docs/cli.md): Standalone `henkaipan` CLI: install, configure, and drive HenKaiPan from any shell or script.
- [CLI Commands](/docs/cli-commands.md): Full reference for every `henkaipan` command, flag, and environment variable.

## User Guide
- [Introduction](/docs/user-guide/01-introduction.md): Overview of HenKaiPan capabilities, navigation and quick-start workflow.
- [Dashboard](/docs/user-guide/02-dashboard.md): Unified dashboard metrics, severity distribution and recent activity.
- [Findings](/docs/user-guide/03-findings.md): Finding lifecycle, triage workflow, SLA deadlines and status tracking.
- [Scans](/docs/user-guide/04-scans.md): Scanner execution, batching and scan result review.
- [Projects](/docs/user-guide/05-projects.md): Create and manage security projects connected to repositories.
- [Compliance](/docs/user-guide/06-compliance.md): SOC 2, ISO 27001 and PCI-DSS control mapping and evidence export.
- [Settings](/docs/user-guide/07-settings.md): Platform settings including users, teams, roles and API tokens.
- [Knowledge Center](/docs/user-guide/08-knowledge.md): Curated remediation guides and AI-generated articles.
- [Reports](/docs/user-guide/09-reports.md): Executive reports with trends, risk scores and SLA compliance.
- [System](/docs/user-guide/10-system.md): System health, audit log and administrative operations.

## Architecture
- [MCP Integration](/docs/architecture/mcp-integration.md): How LLMs and AI agents connect to HenKaiPan through the Model Context Protocol server.
- [Queue Architecture](/docs/architecture/queue-architecture.md): Redis + Asynq background job lifecycle, retries and event flow.
- [CI/CD Integration](/docs/architecture/ci-cd-integration.md): Architecture and data flow of the external CI/CD scan API.

## MCP / Agents
- [MCP Integration guide](/docs/architecture/mcp-integration.md): Connect LLMs and AI agents to HenKaiPan.
- [MCP tools spec](/docs/mcp-tools.json): Machine-readable JSON catalog of all MCP tools.