aljaz/notedeck
1
0
Fork 0
mirror of https://github.com/aljazceru/notedeck.git synced 2025-12-17 08:44:20 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
notedeck/STARTUP_CONFIG.md
Claude 73042a8bd4 Add startup configuration and remove deck creation UI 
- Created startup configuration system for automatic relay and account setup
  - New StartupConfig struct with optional relay and nsec fields
  - Load/save functions for startup_config.json
  - Config file location: ~/.local/share/notedeck/settings/startup_config.json

- Integrated startup config into app initialization
  - Automatically adds account from nsec if provided
  - Automatically connects to relay if provided
  - Loads before default relay configuration

- Removed all deck creation functionality from side panel
  - Removed NewDeck, SwitchDeck, and EditDeck actions
  - Removed deck UI elements (add button, deck list)
  - Simplified side panel to show only essential controls
  - Cleaned up unused code (DECK_ICON_SIZE, unused imports)

- Added documentation
  - STARTUP_CONFIG.md with detailed usage instructions
  - startup_config.json.example with configuration template

This allows users to configure their preferred relay and identity once in a
config file rather than having to set it up each time the application starts.
2025-11-15 10:34:50 +00:00

1.8 KiB
Raw Permalink Blame History

Startup Configuration

Notedeck can be configured to automatically connect to a relay and load your account on startup using a configuration file.

Configuration File Location

Create a file named startup_config.json in:

  • Linux: ~/.local/share/notedeck/settings/startup_config.json
  • macOS: ~/Library/Application Support/notedeck/settings/startup_config.json
  • Windows: %APPDATA%\notedeck\settings\startup_config.json

Configuration Format

The configuration file is a JSON file with the following format:

{
  "relay": "wss://relay.damus.io",
  "nsec": "nsec1your_private_key_here"
}

Fields

  • relay (optional): The WebSocket URL of the relay you want to connect to

    • Example: "wss://relay.damus.io"
    • If not specified, the application will use default relays

  • nsec (optional): Your Nostr private key in nsec format

    • Example: "nsec1..."
    • This will be used to automatically create your account on startup
    • Keep this file secure! Your nsec is your private key and should never be shared

Example Configuration

See startup_config.json.example in the root directory for a template.

Security Notes

  • Never share your nsec with anyone
  • Keep your startup_config.json file secure with appropriate file permissions
  • Back up your nsec in a safe location
  • On Linux/macOS, you can set secure permissions with: 
    chmod 600 ~/.local/share/notedeck/settings/startup_config.json

Notes

  • Both fields are optional - you can specify just the relay, just the nsec, or both
  • If the configuration file doesn't exist, the application will start with default settings
  • The startup configuration is loaded once during application startup
  • Changes to the file require restarting the application to take effect