From 4b40e9010d3edf4371af3e39833cd32ae180c3dd Mon Sep 17 00:00:00 2001 From: Shroominic Date: Mon, 1 Sep 2025 21:42:25 +0100 Subject: [PATCH] correct env var names --- docs/advanced/nostr.md | 16 +++++++++++----- routstr/discovery.py | 2 +- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/docs/advanced/nostr.md b/docs/advanced/nostr.md index 4d7a124a..e3aebcb1 100644 --- a/docs/advanced/nostr.md +++ b/docs/advanced/nostr.md @@ -5,6 +5,7 @@ Routstr Core integrates with Nostr (Notes and Other Stuff Transmitted by Relays) ## Overview Nostr integration provides: + - **Decentralized Discovery**: Find providers through relay network - **Cryptographic Identity**: Providers identified by public keys - **Real-time Updates**: Live provider status and pricing @@ -34,6 +35,7 @@ Providers announce themselves by publishing signed events to Nostr relays. Clien ### Setting Up Nostr Identity 1. **Generate Nostr Keys** + ```bash # Using nostril or similar tool nostril --generate-keypair @@ -44,6 +46,7 @@ Providers announce themselves by publishing signed events to Nostr relays. Clien ``` 2. **Configure Environment** + ```bash # .env NPUB=npub1xyz... # Your public key @@ -104,7 +107,7 @@ DEFAULT_RELAYS = [ ] # Custom relay configuration -NOSTR_RELAYS=wss://relay1.com,wss://relay2.com +RELAYS=wss://relay1.com,wss://relay2.com ``` ## Client Discovery @@ -276,6 +279,7 @@ def select_provider( ### Automatic Updates Routstr publishes updates when: + - Node starts up - Configuration changes - Models are added/removed @@ -295,7 +299,7 @@ async def publish_provider_info(): pricing=get_current_pricing() ) - await publish_to_relays(event, NOSTR_RELAYS) + await publish_to_relays(event, RELAYS) ``` ### Event Lifecycle @@ -315,7 +319,7 @@ async def update_nostr_presence(): async def remove_nostr_presence(): """Remove provider from discovery.""" deletion_event = create_deletion_event() - await publish_to_relays(deletion_event, NOSTR_RELAYS) + await publish_to_relays(deletion_event, RELAYS) ``` ## Security Considerations @@ -323,6 +327,7 @@ async def remove_nostr_presence(): ### Key Management 1. **Secure Storage** + ```python # Never log private keys SENSITIVE_VARS = ['NSEC', 'ADMIN_PASSWORD'] @@ -335,6 +340,7 @@ async def remove_nostr_presence(): ``` 2. **Key Rotation** + ```bash # Generate new keys nostril --generate-keypair @@ -524,7 +530,7 @@ async def debug_discovery(): issues = [] # Check relay connectivity - for relay in NOSTR_RELAYS: + for relay in RELAYS: if not await can_connect_to_relay(relay): issues.append(f"Cannot connect to {relay}") @@ -589,4 +595,4 @@ wscat -c wss://relay.damus.io - [Tor Support](tor.md) - Anonymous provider access - [Custom Pricing](custom-pricing.md) - Dynamic pricing strategies -- [API Reference](../api/endpoints.md) - Discovery API details \ No newline at end of file +- [API Reference](../api/endpoints.md) - Discovery API details diff --git a/routstr/discovery.py b/routstr/discovery.py index dc4929b6..ccf108f5 100644 --- a/routstr/discovery.py +++ b/routstr/discovery.py @@ -259,7 +259,7 @@ async def get_providers( - NIP-91: https://github.com/nostr-protocol/nips/pull/1987 """ # Default relays for provider discovery - # Configure relays: use NOSTR_RELAYS or defaults + # Configure relays: use RELAYS or defaults relays_env = os.getenv("RELAYS") or "" discovery_relays = [r.strip() for r in relays_env.split(",") if r.strip()] if not discovery_relays: