Files
archive-clients/docs/README.md
T

1.9 KiB
Raw Permalink Blame History

Archive Control design documentation

This directory is the implementation contract for Archive Control. These documents incorporate the decisions made during the design review and supersede conflicting details in the original private problem statement. That statement is intentionally not published because it contains deployment credentials and host-specific details.

Reading order

  1. Decisions
  2. Implementation plan
  3. System design
  4. Resource and workflow model
  5. Daemon protocol
  6. Storage safety and recovery
  7. qBittorrent and Syncthing integration
  8. Configuration, deployment, and usage
  9. Deployment preflight tests
  10. Telegram UX
  11. Testing strategy

The independent protobuf source of truth lives in the cabbage/archive-control-proto repository. Generated bindings in this repository record the exact source commit.

Implementation status

As of 2026-07-23, implementation phases 07 are complete across the proto, control, and client repositories. This includes registration, recovery, on-demand inventory, automatic route provisioning, transfer preview and delta planning, selective archive/unarchive merging, durable execution and compensation, safe cache eviction, database backup/restore, and the integrated Telegram flows.

The local 2×2 topology passes archive, eviction, and unarchive happy paths plus selective/partial merges, multiple archive coverage, restart/replay, pure-v2/hybrid identities, stalls, disk exhaustion, hostile preconditions, and protocol duplication/reordering. The integrated bot also has an isolated dummy backend for interactive Telegram conversation review and trace export. Remaining work is the broader release/chaos matrix and the separately approved staged deployment described in phases 89.