Getting Started

Getting Started

This page helps you do your first successful backup and restore with minimal setup.

If you only remember one thing: run a real restore drill and compare the restored file with the original.

Prerequisites

• Install Ethernity (see README).
• Use test data (not real secrets) for your first run.
• Have enough free disk space for a few PDF files.

If you are on Windows, adapt shell examples to PowerShell equivalents.

What You Will Produce

You will usually get these files:

• 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)

First Drill (About 10 Minutes)

Create a tiny test file:

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

Run backup (example with sharding enabled):

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

Now recover from the generated folder:

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

Check that the recovered file matches the original:

cmp ./payload.txt ./restored.txt

If cmp prints nothing and exits successfully, your drill passed.

Design Names

Use supported design names only:

• archive
• forge
• ledger
• maritime
• sentinel

If you are unsure, start with sentinel.

Quick Checklist

• Backup command completed successfully.
• Recovery command completed successfully.
• Restored file matches original.
• Artifacts are stored in separate locations.

Operational Baseline

• Run at least one real drill for each workflow style you plan to rely on.
• Store recovery materials in separate locations.
• Keep an independent backup path.

Verification References

• Format spec
• Format notes

Next Pages

• Backup Workflow
• Backup Playbooks
• Recovery Workflow
• Security and Trust Model
• Recovery Kit

Tip: if anything fails, open Troubleshooting before changing too many settings at once.