Skip to content

Getting Started

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

Getting Started

This page gives a fast, practical first drill for Ethernity stable v1.

Prerequisites

  • Install Ethernity (see README).
  • Use non-critical test data for first run.
  • Keep enough free disk space for generated PDF artifacts.

What You Will Produce

Typical output set:

  • qr_document.pdf
  • recovery_document.pdf
  • optional shard-*-N-of-K.pdf
  • optional signing-key-shard-*-N-of-K.pdf
  • optional recovery_kit_index.pdf (design-dependent)

10-Minute First Drill

Create test input:

printf "ethernity test payload\n" > payload.txt

Run backup (with passphrase sharding + signing-key sharding):

ethernity backup \
  --input ./payload.txt \
  --output-dir ./backup-demo \
  --design ledger \
  --shard-threshold 2 \
  --shard-count 3 \
  --signing-key-mode sharded \
  --signing-key-shard-threshold 2 \
  --signing-key-shard-count 3

Recover from generated artifacts:

ethernity recover --scan ./backup-demo --output ./restored.txt

Verify output:

cmp ./payload.txt ./restored.txt

If cmp exits successfully, your end-to-end drill passed.

Operational Baseline

  • Run at least one drill for every workflow pattern you plan to use.
  • Store recovery materials separately (do not keep everything together).
  • Keep an independent backup path.

Verification References

Next Pages

Clone this wiki locally