399fa62267
Replace Hetzner references with Coolify. Deployment is now: - Core + Compliance: Push gitea → Coolify auto-deploys - Lehrer: stays local on Mac Mini Updated: CLAUDE.md, MkDocs CI/CD pipeline, MkDocs index. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
128 lines
5.1 KiB
Markdown
128 lines
5.1 KiB
Markdown
# BreakPilot Compliance - Dokumentation
|
|
|
|
Willkommen zur Dokumentation des **BreakPilot Compliance**-Stacks (Team B: DSGVO/Compliance).
|
|
|
|
## Drei-Projekt-Architektur
|
|
|
|
| Projekt | Beschreibung | Docs |
|
|
|---------|-------------|------|
|
|
| **breakpilot-core** | Shared Infrastructure (DB, Cache, Vault, Nginx) | Port 8009 |
|
|
| **breakpilot-lehrer** | Bildungs-Stack | Port 8010 |
|
|
| **breakpilot-compliance** (dieses Projekt) | DSGVO/Compliance-Stack | Port 8011 |
|
|
|
|
Compliance haengt **ausschliesslich von Core** ab (PostgreSQL, Valkey, Vault, Qdrant, MinIO, Embedding, RAG).
|
|
Es gibt **keine Laufzeitabhaengigkeit** zu breakpilot-lehrer.
|
|
|
|
---
|
|
|
|
## Services
|
|
|
|
| Service | Container | Port | Tech | Beschreibung |
|
|
|---------|-----------|------|------|--------------|
|
|
| Admin Compliance | bp-compliance-admin | 3007 | Next.js | Compliance-Dashboard |
|
|
| Developer Portal | bp-compliance-developer-portal | 3006 | Next.js | API-Dokumentation fuer Kunden |
|
|
| Backend Compliance | bp-compliance-backend | 8002 | Python/FastAPI | Compliance API |
|
|
| AI Compliance SDK | bp-compliance-ai-sdk | 8090/8093 | Go/Gin | DSGVO-konforme KI-Nutzung |
|
|
| DSMS Node | bp-compliance-dsms-node | 4001/5001 | IPFS | Dezentrales Datenschutz-Management |
|
|
| DSMS Gateway | bp-compliance-dsms-gateway | 8082 | Node.js/Express | IPFS Gateway |
|
|
| Document Crawler | bp-compliance-document-crawler | 8098 | Python | Web-Crawler fuer Rechtstexte |
|
|
|
|
---
|
|
|
|
## SDK-Module (Kundenbereich)
|
|
|
|
Module die Compliance-Kunden im SDK sehen und nutzen:
|
|
|
|
| Modul | Beschreibung | Frontend |
|
|
|-------|--------------|----------|
|
|
| **TOM** | Technisch-Organisatorische Massnahmen | /sdk/tom |
|
|
| **DSFA** | Datenschutz-Folgenabschaetzung | /sdk/dsfa |
|
|
| **VVT** | Verzeichnis von Verarbeitungstaetigkeiten | /sdk/vvt |
|
|
| **Loeschfristen** | Loeschfristen-Verwaltung | /sdk/loeschfristen |
|
|
| **Requirements** | Compliance-Anforderungen (CRUD + RAG) | /sdk/requirements |
|
|
| **Controls** | Technische/Organisatorische Kontrollen | /sdk/controls |
|
|
| **Evidence** | Compliance-Nachweise mit Gueltigkeit | /sdk/evidence |
|
|
| **Risk Matrix** | 5x5 Risikomatrix (Inherent/Residual) | /sdk/risks |
|
|
| **AI Act Compliance** | KI-Verordnung Konformitaet | /sdk/ai-act |
|
|
| **Obligations v2** | 325 Pflichten aus 9 Regulierungen, TOM-Mapping, Gap-Analyse | /sdk/obligations |
|
|
| **IACE** | CE-Risikobeurteilung (Maschinenverordnung, AI Act, CRA) | /sdk/iace |
|
|
| **Audit Checklist** | Audit-Checkliste mit Sign-Off | /sdk/audit-checklist |
|
|
| **Audit Report** | Audit-Berichte mit PDF-Export | /sdk/audit-report |
|
|
| **Consent Management** | Einwilligungs-Verwaltung | /sdk/einwilligungen |
|
|
| **DSR** | Betroffenenrechte (Art. 15-21 DSGVO) | /sdk/dsr |
|
|
| **E-Mail-Templates** | Benachrichtigungs-Vorlagen (DSR, Incidents, Schulungen) | /sdk/email-templates |
|
|
| **Academy** | Datenschutz-Schulungen mit PDF-Zertifikaten | /sdk/academy |
|
|
| **Training Engine** | KI-generierte Schulungen, Quiz, Rollenmatrix, TTS-Video | /sdk/training |
|
|
| **Whistleblower** | Hinweisgebersystem (HinSchG) | /sdk/whistleblower |
|
|
| **Incidents** | Datenschutz-Vorfaelle (Art. 33/34 DSGVO) | /sdk/incidents |
|
|
| **Vendors** | Auftragsverarbeiter-Management | /sdk/vendor-compliance |
|
|
| **Reporting** | Compliance-Berichte fuer Top Management | /sdk/reporting |
|
|
| **Import** | Dokument-Import + Gap-Analyse | /sdk/import |
|
|
| **Screening** | SBOM + CVE-Scan via OSV.dev | /sdk/screening |
|
|
| **RAG/Quellen** | Semantische Suche in Regulierungstexten | /sdk/rag |
|
|
| **Industry Templates** | Branchenvorlagen (E-Commerce, Gesundheit, etc.) | /sdk/industry-templates |
|
|
| **Document Crawler** | Automatisches Crawling von Rechtstexten | /sdk/document-crawler |
|
|
| **Advisory Board** | KI-Compliance-Beirat | /sdk/advisory-board |
|
|
|
|
---
|
|
|
|
## URLs
|
|
|
|
### Production (Coolify-deployed)
|
|
|
|
| URL | Service | Beschreibung |
|
|
|-----|---------|--------------|
|
|
| https://admin-dev.breakpilot.ai/ | Admin Compliance | Compliance-Dashboard |
|
|
| https://developers-dev.breakpilot.ai/ | Developer Portal | API-Dokumentation |
|
|
| https://api-dev.breakpilot.ai/ | Backend API | Compliance REST API |
|
|
| https://sdk-dev.breakpilot.ai/ | AI SDK API | SDK Backend-API |
|
|
|
|
### Lokal (Mac Mini — nur Dev/Tests)
|
|
|
|
| URL | Service |
|
|
|-----|---------|
|
|
| https://macmini:3007/ | Admin Compliance |
|
|
| https://macmini:3006/ | Developer Portal |
|
|
| https://macmini:8002/ | Backend API |
|
|
| https://macmini:8093/ | AI SDK API |
|
|
|
|
---
|
|
|
|
## Deployment
|
|
|
|
```bash
|
|
# Production (Coolify — Standardweg):
|
|
git push origin main && git push gitea main
|
|
# Coolify baut und deployt automatisch.
|
|
|
|
# Lokal (Mac Mini — nur Dev/Tests):
|
|
docker compose -f breakpilot-compliance/docker-compose.yml up -d
|
|
```
|
|
|
|
---
|
|
|
|
## Git
|
|
|
|
```bash
|
|
# Zwei Remotes - IMMER zu beiden pushen:
|
|
git push origin main && git push gitea main
|
|
|
|
# Remotes:
|
|
# origin: http://macmini:3003/pilotadmin/breakpilot-compliance.git
|
|
# gitea: git@gitea.meghsakha.com:Benjamin_Boenisch/breakpilot-compliance.git
|
|
```
|
|
|
|
---
|
|
|
|
## Services-Dokumentation
|
|
|
|
- [AI Compliance SDK](services/ai-compliance-sdk/index.md)
|
|
- [Document Crawler](services/document-crawler/index.md)
|
|
- SDK-Module: siehe Unterverzeichnisse
|
|
|
|
## Entwicklung
|
|
|
|
- [Testing](development/testing.md)
|
|
- [Dokumentation](development/documentation.md)
|
|
- [CI/CD Pipeline](development/ci-cd-pipeline.md)
|