How 0neshot101/ferrum works
Ferrum is a multi-format package gateway: clients use ordinary package-manager URLs, while the service authenticates repository metadata, fetches and verifies package bodies on demand, and serves them from bounded local storage backed by private S3-compatible storage. The main runtime path is configured and assembled at startup, then public requests pass through the HTTP server and shared-fill fetch path. Separate branches cover suite synchronization and publication, recovery, administration, and the dashboard. Edges use the README and source-index references; unsampled integration details are left unverified.
Main entry points: routes.rs Admin routes · app.rs Startup wiring · sync.rs Suite synchronization · server.rs Public HTTP
Components 23
Gateway runtime
- Startup wiring
crates/ferrum/src/app.rs - Runtime config
crates/ferrum/src/config.rs - Public HTTP
crates/ferrum/src/server.rs - Shared package fills
crates/ferrum/src/fetch.rs
Repository trust
- Suite synchronization
crates/ferrum/src/sync.rs - Metadata parsers
crates/ferrum-apt/src/index.rs - Signature verifier
crates/ferrum-verifier/src/main.rs
Storage and recovery
- Capture and budgets
crates/ferrum-storage/src/capture.rs - SQLite catalog
crates/ferrum-storage/src/catalog.rs - Local object spool
crates/ferrum-storage/src/disk.rs - S3 transport
crates/ferrum-storage/src/s3/production.rs - Generation recovery
crates/ferrum-storage/src/recovery.rs
Operations and admin
- Health and metrics
crates/ferrum/src/health.rs - Admin routes
crates/ferrum/src/admin/routes.rs - Operation jobs
crates/ferrum/src/admin/jobs.rs - Package prewarming
crates/ferrum/src/prewarm.rs
Admin dashboard
- Storage dashboard
ui/src/lib/components/StoragePage.svelte - Dashboard API client
ui/src/lib/services/api.ts
Other components
- Package client
- Operator
- Repository origin
- S3 service
- Admin user
Connections 28
- Package client → Public HTTP: requests packages
README.md - Startup wiring → Runtime config: loads settings
crates/ferrum/src/app.rs - Startup wiring → Public HTTP: wires listener
crates/ferrum/src/app.rs - Startup wiring → Shared package fills: wires fills
crates/ferrum/src/app.rs - Startup wiring → Suite synchronization: wires synchronizer
crates/ferrum/src/app.rs - Startup wiring → Health and metrics: wires health
crates/ferrum/src/app.rs - Public HTTP → Shared package fills: requests fills
crates/ferrum/src/server.rs - Public HTTP → Health and metrics: records metrics
crates/ferrum/src/server.rs - Shared package fills → Repository origin: fetches bodies
- Suite synchronization → Repository origin: fetches metadata
crates/ferrum/src/sync.rs - Suite synchronization → Metadata parsers: parses indexes
crates/ferrum/src/sync.rs - Metadata parsers → Signature verifier: authenticates metadata
- Suite synchronization → SQLite catalog: publishes view
- Capture and budgets → SQLite catalog: records captures
crates/ferrum-storage/src/capture.rs - Capture and budgets → Local object spool: stages objects
crates/ferrum-storage/src/capture.rs - Capture and budgets → S3 transport: stores captures
crates/ferrum-storage/src/capture.rs - S3 transport → S3 service: transfers objects
- Generation recovery → SQLite catalog: reads publication state
crates/ferrum-storage/src/recovery.rs - Generation recovery → S3 transport: recovers generations
crates/ferrum-storage/src/recovery.rs - Generation recovery → Signature verifier: verifies proofs
crates/ferrum-storage/src/recovery.rs - Health and metrics → Admin routes: mounts admin routes
crates/ferrum/src/health.rs - Admin routes → Operation jobs: routes job requests
crates/ferrum/src/admin/routes.rs - Admin routes → Health and metrics: serves telemetry
crates/ferrum/src/admin/routes.rs - Operator → Admin routes: manages gateway
README.md - Admin routes → Package prewarming: routes prewarm
crates/ferrum/src/admin/routes.rs - Admin user → Storage dashboard: views storage
README.md - Storage dashboard → Dashboard API client: calls storage API
ui/src/lib/components/StoragePage.svelte - Dashboard API client → Admin routes: sends admin requests