mirror of
https://github.com/PR0M3TH3AN/SeedPass.git
synced 2025-09-07 23:08:43 +00:00
Document restoration requirements
This commit is contained in:
13
README.md
13
README.md
@@ -561,13 +561,16 @@ The default configuration uses **50,000** PBKDF2 iterations. Increase this value
|
|||||||
### Recovery
|
### Recovery
|
||||||
|
|
||||||
If you previously backed up your vault to Nostr you can restore it during the
|
If you previously backed up your vault to Nostr you can restore it during the
|
||||||
initial setup:
|
initial setup. You must provide both your 12‑word master seed and the master
|
||||||
|
password that encrypted the vault; without the correct password the retrieved
|
||||||
|
data cannot be decrypted.
|
||||||
|
|
||||||
1. Start SeedPass and choose option **4** when prompted to set up a seed.
|
1. Start SeedPass and choose option **4** when prompted to set up a seed.
|
||||||
2. Paste your BIP-85 seed phrase when asked.
|
2. Paste your BIP‑85 seed phrase when asked.
|
||||||
3. SeedPass initializes the profile and attempts to download the encrypted vault
|
3. Enter the master password associated with that seed.
|
||||||
from the configured relays.
|
4. SeedPass initializes the profile and attempts to download the encrypted
|
||||||
4. A success message confirms the vault was restored. If no data is found a
|
vault from the configured relays.
|
||||||
|
5. A success message confirms the vault was restored. If no data is found a
|
||||||
failure message is shown and a new empty vault is created.
|
failure message is shown and a new empty vault is created.
|
||||||
|
|
||||||
## Running Tests
|
## Running Tests
|
||||||
|
@@ -46,6 +46,7 @@ maintainable while enabling a consistent experience on multiple platforms.
|
|||||||
- [Running the Application](#running-the-application)
|
- [Running the Application](#running-the-application)
|
||||||
- [Managing Multiple Seeds](#managing-multiple-seeds)
|
- [Managing Multiple Seeds](#managing-multiple-seeds)
|
||||||
- [Additional Entry Types](#additional-entry-types)
|
- [Additional Entry Types](#additional-entry-types)
|
||||||
|
- [Recovery](#recovery)
|
||||||
- [Security Considerations](#security-considerations)
|
- [Security Considerations](#security-considerations)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
- [License](#license)
|
- [License](#license)
|
||||||
@@ -405,6 +406,22 @@ SeedPass allows you to manage multiple seed profiles (previously referred to as
|
|||||||
|
|
||||||
**Note:** The term "seed profile" is used to represent different sets of seeds you can manage within SeedPass. This provides an intuitive way to handle multiple identities or sets of passwords.
|
**Note:** The term "seed profile" is used to represent different sets of seeds you can manage within SeedPass. This provides an intuitive way to handle multiple identities or sets of passwords.
|
||||||
|
|
||||||
|
|
||||||
|
### Recovery
|
||||||
|
|
||||||
|
If you previously backed up your vault to Nostr you can restore it during the
|
||||||
|
initial setup. You must provide both your 12 -word master seed and the master
|
||||||
|
password that encrypted the vault; without the correct password the retrieved
|
||||||
|
data cannot be decrypted.
|
||||||
|
|
||||||
|
1. Start SeedPass and choose option **4** when prompted to set up a seed.
|
||||||
|
2. Paste your BIP‑85 seed phrase when asked.
|
||||||
|
3. Enter the master password associated with that seed.
|
||||||
|
4. SeedPass initializes the profile and attempts to download the encrypted
|
||||||
|
vault from the configured relays.
|
||||||
|
5. A success message confirms the vault was restored. If no data is found a
|
||||||
|
failure message is shown and a new empty vault is created.
|
||||||
|
|
||||||
### Configuration File and Settings
|
### Configuration File and Settings
|
||||||
|
|
||||||
SeedPass keeps per-profile settings in an encrypted file named `seedpass_config.json.enc` inside each profile directory under `~/.seedpass/`. This file stores your chosen Nostr relays and the optional settings PIN. New profiles start with the following default relays:
|
SeedPass keeps per-profile settings in an encrypted file named `seedpass_config.json.enc` inside each profile directory under `~/.seedpass/`. This file stores your chosen Nostr relays and the optional settings PIN. New profiles start with the following default relays:
|
||||||
|
@@ -202,6 +202,8 @@ flowchart TD
|
|||||||
<p>SeedPass allows you to manage multiple seed profiles (fingerprints). You can switch between different seeds to compartmentalize your passwords.</p>
|
<p>SeedPass allows you to manage multiple seed profiles (fingerprints). You can switch between different seeds to compartmentalize your passwords.</p>
|
||||||
<h3 class="subsection-title">Nostr Relay Integration</h3>
|
<h3 class="subsection-title">Nostr Relay Integration</h3>
|
||||||
<p>SeedPass publishes your encrypted vault to Nostr in 50 KB chunks using parameterised replaceable events. A manifest describes each snapshot while deltas record updates. When too many deltas accumulate, a new snapshot is rotated in automatically.</p>
|
<p>SeedPass publishes your encrypted vault to Nostr in 50 KB chunks using parameterised replaceable events. A manifest describes each snapshot while deltas record updates. When too many deltas accumulate, a new snapshot is rotated in automatically.</p>
|
||||||
|
<h3 class="subsection-title">Recovery from Nostr</h3>
|
||||||
|
<p>Restoring a vault on a new device requires both your 12 word master seed and the master password that encrypted the vault. Without the correct password the downloaded archive cannot be decrypted.</p>
|
||||||
<h3 class="subsection-title">Checksum Verification</h3>
|
<h3 class="subsection-title">Checksum Verification</h3>
|
||||||
<p>Built-in checksum verification ensures your SeedPass installation hasn't been tampered with.</p>
|
<p>Built-in checksum verification ensures your SeedPass installation hasn't been tampered with.</p>
|
||||||
<h3 class="subsection-title">Interactive TUI</h3>
|
<h3 class="subsection-title">Interactive TUI</h3>
|
||||||
|
Reference in New Issue
Block a user