Mikhail ChusavitinandClaude Sonnet 5
4a4910f207
Detection-only scan (internal/privacy) attached to every AnalysisResult: a customer-domain guess plus a findings list (category, file, line, match, hint), ported from the KB grep playbook. Runs on archive uploads and the serialized Redfish tree; gated by LOGPILE_PRIVACY_SCAN (default on). Surfaced at GET /api/privacy-scan, in the "Customer data" UI panel, and as privacy_report.json in the raw-export bundle. IP policy keeps RFC1918 and example ranges out of findings; allowlist covers standards-body and vendor infrastructure domains. No customer tokens in the repo. See ADL-066 and bible-local/docs/privacy-scan.md. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
44 lines
1.8 KiB
Markdown
44 lines
1.8 KiB
Markdown
# LOGPile Bible
|
|
|
|
`bible-local/` is the project-specific source of truth for LOGPile.
|
|
Keep top-level docs minimal and put maintained architecture/API contracts here.
|
|
|
|
## Rules
|
|
|
|
- Documentation language: English only
|
|
- Update relevant bible files in the same change as the code
|
|
- Record significant architectural decisions in [`10-decisions.md`](10-decisions.md)
|
|
- Do not duplicate shared rules from `bible/`
|
|
|
|
## Read order
|
|
|
|
| File | Purpose |
|
|
|------|---------|
|
|
| [01-overview.md](01-overview.md) | Product scope, modes, non-goals |
|
|
| [02-architecture.md](02-architecture.md) | Runtime structure, state, main flows |
|
|
| [04-data-models.md](04-data-models.md) | Stable data contracts and canonical inventory |
|
|
| [03-api.md](03-api.md) | HTTP endpoints and response contracts |
|
|
| [05-collectors.md](05-collectors.md) | Live collection behavior |
|
|
| [06-parsers.md](06-parsers.md) | Archive parser framework and vendor coverage |
|
|
| [07-exporters.md](07-exporters.md) | Raw export, Reanimator export, batch convert |
|
|
| [docs/hardware-ingest-contract.md](docs/hardware-ingest-contract.md) | Reanimator ingest schema mirrored locally |
|
|
| [docs/privacy-scan.md](docs/privacy-scan.md) | Customer-data / anonymization scan of ingested sources |
|
|
| [08-build-release.md](08-build-release.md) | Build and release workflow |
|
|
| [09-testing.md](09-testing.md) | Test expectations and regression rules |
|
|
| [10-decisions.md](10-decisions.md) | Architectural Decision Log |
|
|
|
|
## Fast orientation
|
|
|
|
- Entry point: `cmd/logpile/main.go`
|
|
- HTTP layer: `internal/server/`
|
|
- Core contracts: `internal/models/models.go`
|
|
- Live collection: `internal/collector/`
|
|
- Archive parsing: `internal/parser/`
|
|
- Export conversion: `internal/exporter/`
|
|
- Frontend consumer: `web/static/js/app.js`
|
|
|
|
## Maintenance rule
|
|
|
|
If a document becomes stale, either fix it immediately or delete it.
|
|
Stale docs are worse than missing docs.
|