mirror of
https://github.com/PR0M3TH3AN/SeedPass.git
synced 2025-09-07 14:58:56 +00:00
Document config file and settings menu
This commit is contained in:
22
README.md
22
README.md
@@ -134,9 +134,10 @@ python src/main.py
|
||||
10. Add a New Seed Profile
|
||||
11. Remove an Existing Seed Profile
|
||||
12. List All Seed Profiles
|
||||
13. Exit
|
||||
13. Settings
|
||||
14. Exit
|
||||
|
||||
Enter your choice (1-13):
|
||||
Enter your choice (1-14):
|
||||
```
|
||||
|
||||
### Managing Multiple Seeds
|
||||
@@ -159,6 +160,23 @@ 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.
|
||||
|
||||
### 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:
|
||||
|
||||
```
|
||||
wss://relay.snort.social
|
||||
wss://nostr.oxtr.dev
|
||||
wss://relay.primal.net
|
||||
```
|
||||
|
||||
You can update the relay list or change the PIN through the **Settings** menu:
|
||||
|
||||
1. From the main menu, choose option `13` (**Settings**).
|
||||
2. Select `1` to enter a comma-separated list of relay URLs.
|
||||
3. Choose `2` to change the settings PIN.
|
||||
4. Select `3` to go back to the main menu.
|
||||
|
||||
## Running Tests
|
||||
|
||||
SeedPass includes a small suite of unit tests. After activating your virtual environment and installing dependencies, run the tests with **pytest**:
|
||||
|
@@ -418,7 +418,13 @@ seedpass show-pubkey
|
||||
|
||||
**Description:**
|
||||
Allows users to specify custom Nostr relays for publishing their encrypted backup index, providing flexibility and control over data distribution.
|
||||
Relay URLs are stored in an encrypted configuration file and loaded each time the Nostr client starts. New accounts use the default relays until changed.
|
||||
Relay URLs are stored in an encrypted configuration file located in `~/.seedpass/<fingerprint>/seedpass_config.json.enc` and loaded each time the Nostr client starts. New accounts use the following default relays until changed:
|
||||
|
||||
```
|
||||
wss://relay.snort.social
|
||||
wss://nostr.oxtr.dev
|
||||
wss://relay.primal.net
|
||||
```
|
||||
|
||||
**Usage Example:**
|
||||
```bash
|
||||
|
Reference in New Issue
Block a user