alee/fieldwitness
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
6325e86873
fieldwitness/docs/index.md
Aaron D. Lee 6325e86873
Some checks failed
CI / lint (push) Failing after 1m1s
Details
CI / typecheck (push) Failing after 31s
Details
Comprehensive documentation for v0.2.0 release 
README.md (700 lines):
- Three-tier deployment model with ASCII diagram
- Federation blueprint in web UI routes
- deploy/ directory in architecture tree
- Documentation index linking all guides

CLAUDE.md (256 lines):
- Updated architecture tree with all new docs and deploy files

New guides:
- docs/federation.md (317 lines) — gossip protocol mechanics, peer
  setup, trust filtering, offline bundles, relay deployment, jurisdiction
- docs/evidence-guide.md (283 lines) — evidence packages, cold archives,
  selective disclosure, chain anchoring, legal discovery workflow
- docs/source-dropbox.md (220 lines) — token management, client-side
  hashing, extract-then-strip pipeline, receipt mechanics, opsec
- docs/index.md — documentation hub linking all guides

Training materials:
- docs/training/reporter-quickstart.md (105 lines) — printable one-page
  card: boot USB, attest photo, encode message, check-in, emergency
- docs/training/emergency-card.md (79 lines) — wallet-sized laminated
  card: three destruction methods, 10-step order, key contacts
- docs/training/admin-reference.md (219 lines) — deployment tiers,
  CLI tables, backup checklist, hardening checklist, troubleshooting

Also includes existing architecture docs from the original repos.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-01 23:31:47 -04:00

2.1 KiB
Raw Blame History

SooSeF Documentation

For Reporters and Field Users

Document Description
Reporter Quick-Start One-page card for Tier 1 USB users. Print, laminate, keep with the USB.
Reporter Field Guide Comprehensive guide: attesting photos, steganography, killswitch, backups, evidence packages.
Emergency Card Wallet-sized reference for emergency data destruction. Print and laminate.

For Administrators

Document Description
Admin Quick Reference CLI cheat sheet, hardening checklist, troubleshooting table.
Admin Operations Guide Full procedures: user management, drop box, federation, key rotation, incident response.
Deployment Guide Three-tier deployment: bootable USB, Docker org server, Kubernetes federation relay. Threat level presets, security hardening, systemd setup.

Feature Guides

Document Description
Federation Guide Gossip protocol setup, offline bundles, peer management, relay deployment.
Evidence Guide Evidence packages, cold archives, selective disclosure, chain anchoring, legal discovery workflow.
Source Drop Box Anonymous file intake: tokens, EXIF pipeline, receipt codes, operational security.

Architecture (Developer Reference)

Document Description
Federation Architecture System design: threat model, layers (chain, bundles, federation), key domains, permission tiers.
Chain Format Spec CBOR record format, entropy witnesses, serialization, storage format, content types.
Export Bundle Spec SOOSEFX1 binary format, envelope encryption (X25519 + AES-256-GCM), Merkle trees.
Federation Protocol Spec CT-inspired server protocol: API endpoints, gossip, storage tiers, receipts, security model.