Configuration and Defaults

Configuration and Defaults

Use this page to keep operator defaults predictable and safe.

Precedence Rules

Effective value order:

CLI > Environment > Config > built-in default

Examples:

• --design forge overrides config design defaults.
• ETHERNITY_RENDER_JOBS overrides [runtime].render_jobs.
• If neither is set, built-in defaults apply.

Safe Operator Baseline

Recommended baseline:

• keep defaults minimal
• set only values you use frequently
• keep risky decisions explicit per command

[defaults.backup]
output_dir = ""
shard_threshold = 0
shard_count = 0
signing_key_mode = ""
payload_codec = "auto" # auto | raw | gzip
qr_payload_codec = "raw" # raw | base64

[defaults.recover]
output = ""

[ui]
quiet = false
no_color = false
no_animations = false

[debug]
max_bytes = 1024

[runtime]
render_jobs = "auto"

Codec Defaults

Use backup defaults to control both envelope payload storage and QR transport:

• payload_codec:
  • auto (recommended baseline; gzip only when smaller)
  • raw (never compress)
  • gzip (always compress)
• qr_payload_codec:
  • raw (recommended baseline for scan-heavy workflows)
  • base64 (text-oriented payload workflows)

Note: codec mode is normally configured through defaults/onboarding. Backup command flags do not currently expose per-run codec toggles.

What Should Stay CLI-Only

Keep these as explicit per-run decisions:

• --rescue-mode
• --yes
• --debug-reveal-secrets

This keeps high-risk behavior visible in command history and review.

Design Defaults

Supported design names:

• archive
• forge
• ledger
• maritime
• sentinel

If unsure, start with sentinel.

Validation Routine

Before depending on defaults in production:

1. Run ethernity --help and command help for the exact subcommand.
2. Execute one end-to-end backup/recover drill with your config.
3. Confirm expected output paths and artifact distribution.
4. Record the config version/hash used in your runbook.

Related

• Command Cheatsheet
• Getting Started
• Backup Workflow