Skip to content

Recovery Kit

Alex Stoyanov edited this page Mar 2, 2026 · 6 revisions

Recovery Kit

The recovery kit is a browser helper for environments where CLI-first recovery is not practical.

If you are unsure, start with recovery_kit.bundle.html.

Variants

Ethernity ships two kit bundles:

  • recovery_kit.bundle.html (lean)
    • smaller file size
    • no built-in camera scanner
  • recovery_kit.scanner.bundle.html (scanner)
    • larger file size
    • includes camera scanning support
Need Recommended variant
Smallest artifact lean
Camera scanning in browser scanner
Mostly paste/text inputs lean
Unknown browser camera reliability scanner

Operator Usage Pattern

  1. Open the kit file in a controlled, preferably offline, environment.
  2. Import one backup set only.
  3. Complete recovery and validate output.
  4. If recovery fails, clear state and retry with clean inputs from the same set.

Operator Safety Notes

  • Treat browser online/offline status as a hint, not a hard guarantee.
  • Prefer paste/text inputs when camera behavior is unreliable.
  • Keep shard/auth inputs grouped by document id.

Common Failure Patterns

  • Camera permission denied: switch to paste-based input.
  • Mixed backup sets: clear state and import one set only.
  • Fallback parse errors: re-copy source text to avoid wrapped/altered lines.

Contributor Build Notes

The kit build requires libdeflate-gzip.

cd kit
npm ci
# Install libdeflate-gzip first (for example: apt install libdeflate-tools)
node build_kit.mjs

Build output targets:

  • kit/dist/
  • src/ethernity/kit/

For release gate details, see Maintainer Release Runbook.

Related

Clone this wiki locally