391aab83e0
Some checks failed
CI/CD / loc-budget (push) Successful in 19s
CI/CD / guardrail-integrity (push) Has been skipped
CI/CD / go-lint (push) Has been skipped
CI/CD / python-lint (push) Has been skipped
CI/CD / nodejs-lint (push) Has been skipped
CI/CD / test-go-ai-compliance (push) Successful in 44s
CI/CD / test-python-backend-compliance (push) Failing after 38s
CI/CD / test-python-document-crawler (push) Successful in 30s
CI/CD / sbom-scan (push) Has been cancelled
CI/CD / validate-canonical-controls (push) Has been cancelled
CI/CD / test-python-dsms-gateway (push) Has been cancelled
- Remove Apache-2.0 badge and License section - Update dev workflow to feature branch model (feat/*, feature/*, hotfix/*) - Fix clone URL to SSH - Remove coolify-specific branch references Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
129 lines
5.2 KiB
Markdown
129 lines
5.2 KiB
Markdown
# breakpilot-compliance
|
|
|
|
**DSGVO/AI-Act compliance platform — 10 services, Go · Python · TypeScript**
|
|
|
|
[](https://gitea.meghsakha.com/Benjamin_Boenisch/breakpilot-compliance/actions)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
## Overview
|
|
|
|
breakpilot-compliance is a multi-tenant DSGVO/EU AI Act compliance platform that provides an SDK for consent management, data subject requests (DSR), audit logging, iACE impact assessments, and document archival. It ships as 10 containerised services covering an admin dashboard, a developer portal, a Python/FastAPI backend, a Go AI compliance engine, TTS, and a decentralised document store on IPFS. Every service is deployed automatically via Gitea Actions → Coolify on every push to `main`.
|
|
|
|
---
|
|
|
|
## Architecture
|
|
|
|
| Service | Tech | Port | Container |
|
|
|---------|------|------|-----------|
|
|
| admin-compliance | Next.js 15 | 3007 | bp-compliance-admin |
|
|
| backend-compliance | Python / FastAPI 0.123 | 8002 | bp-compliance-backend |
|
|
| ai-compliance-sdk | Go 1.24 / Gin | 8093 | bp-compliance-ai-sdk |
|
|
| developer-portal | Next.js 15 | 3006 | bp-compliance-developer-portal |
|
|
| breakpilot-compliance-sdk | TypeScript SDK (React/Vue/Angular/vanilla) | — | — |
|
|
| consent-sdk | JS/TS Consent SDK | — | — |
|
|
| compliance-tts-service | Python / Piper TTS | 8095 | bp-compliance-tts |
|
|
| document-crawler | Python / FastAPI | 8098 | bp-compliance-document-crawler |
|
|
| dsms-gateway | Python / FastAPI / IPFS | 8082 | bp-compliance-dsms-gateway |
|
|
| dsms-node | IPFS Kubo v0.24.0 | — | bp-compliance-dsms-node |
|
|
|
|
All containers share the external `breakpilot-network` Docker network and depend on `breakpilot-core` (Valkey, Vault, RAG service, Nginx reverse proxy).
|
|
|
|
---
|
|
|
|
## Quick Start
|
|
|
|
**Prerequisites:** Docker, Go 1.24+, Python 3.12+, Node.js 20+
|
|
|
|
```bash
|
|
git clone ssh://git@coolify.meghsakha.com:22222/Benjamin_Boenisch/breakpilot-compliance.git
|
|
cd breakpilot-compliance
|
|
|
|
# Copy and populate secrets (never commit .env)
|
|
cp .env.example .env
|
|
|
|
# Start all services
|
|
docker compose up -d
|
|
```
|
|
|
|
For the Coolify/Hetzner production target (x86_64), use the override:
|
|
|
|
```bash
|
|
docker compose -f docker-compose.yml -f docker-compose.hetzner.yml up -d
|
|
```
|
|
|
|
---
|
|
|
|
## Development Workflow
|
|
|
|
Use feature branches off `main`. Supported prefixes: `feat/`, `feature/`, `hotfix/`.
|
|
|
|
```bash
|
|
git checkout main && git pull origin main
|
|
git checkout -b feat/my-change
|
|
# ... make changes ...
|
|
git push origin feat/my-change
|
|
# Open a PR → squash merge to main
|
|
```
|
|
|
|
Push to `main` triggers:
|
|
1. **Gitea Actions** — lint → test → validate (see CI Pipeline below)
|
|
2. **Coolify** — automatic build + deploy (~3 min total)
|
|
|
|
Monitor status: <https://gitea.meghsakha.com/Benjamin_Boenisch/breakpilot-compliance/actions>
|
|
|
|
---
|
|
|
|
## CI Pipeline
|
|
|
|
Defined in `.gitea/workflows/ci.yaml`.
|
|
|
|
| Job | What it checks |
|
|
|-----|----------------|
|
|
| `loc-budget` | All source files ≤ 500 LOC; soft target 300 |
|
|
| `guardrail-integrity` | Commits touching guardrail files carry `[guardrail-change]` |
|
|
| `go-lint` | `golangci-lint` on `ai-compliance-sdk/` |
|
|
| `python-lint` | `ruff` + `mypy` on Python services |
|
|
| `nodejs-lint` | `tsc --noEmit` + ESLint on Next.js services |
|
|
| `test-go-ai-compliance` | `go test ./...` in `ai-compliance-sdk/` |
|
|
| `test-python-backend-compliance` | `pytest` in `backend-compliance/` |
|
|
| `test-python-document-crawler` | `pytest` in `document-crawler/` |
|
|
| `test-python-dsms-gateway` | `pytest test_main.py` in `dsms-gateway/` |
|
|
| `sbom-scan` | License + vulnerability scan via `syft` + `grype` |
|
|
| `validate-canonical-controls` | OpenAPI contract baseline diff |
|
|
|
|
---
|
|
|
|
## File Budget
|
|
|
|
| Limit | Value | How to check |
|
|
|-------|-------|--------------|
|
|
| Soft target | 300 LOC | `bash scripts/check-loc.sh` |
|
|
| Hard cap | 500 LOC | Same; also enforced by `PreToolUse` hook + git pre-commit + CI |
|
|
| Exceptions | `.claude/rules/loc-exceptions.txt` | Require written rationale + `[guardrail-change]` commit marker |
|
|
|
|
The `.claude/settings.json` `PreToolUse` hook blocks Claude Code from writing or editing files that would exceed the hard cap. The git pre-commit hook re-checks. CI is the final gate.
|
|
|
|
---
|
|
|
|
## Links
|
|
|
|
| | URL |
|
|
|-|-----|
|
|
| Admin dashboard | <https://admin-dev.breakpilot.ai> |
|
|
| Developer portal | <https://developers-dev.breakpilot.ai> |
|
|
| Backend API | <https://api-dev.breakpilot.ai> |
|
|
| AI SDK API | <https://sdk-dev.breakpilot.ai> |
|
|
| Gitea repo | <https://gitea.meghsakha.com/Benjamin_Boenisch/breakpilot-compliance> |
|
|
| Gitea Actions | <https://gitea.meghsakha.com/Benjamin_Boenisch/breakpilot-compliance/actions> |
|
|
|