|
| 1 | +# NostrKey Browser Support |
| 2 | + |
| 3 | +NostrKey is available for multiple browsers. Choose your browser below for installation and usage instructions. |
| 4 | + |
| 5 | +--- |
| 6 | + |
| 7 | +## 🌐 Chrome / Chromium-based Browsers |
| 8 | + |
| 9 | +**Supported Browsers:** Chrome, Edge, Brave, Opera, Vivaldi, Arc |
| 10 | + |
| 11 | +### Installation from Chrome Web Store |
| 12 | +1. Visit the [Chrome Web Store](https://chrome.google.com/webstore) (link coming soon) |
| 13 | +2. Click **Add to Chrome** |
| 14 | +3. Click **Add extension** in the confirmation dialog |
| 15 | +4. The NostrKey icon will appear in your browser toolbar |
| 16 | + |
| 17 | +### Manual Installation (Developer Mode) |
| 18 | +1. Download the latest release from [Releases](https://github.com/HumanjavaEnterprises/nostrkey.browser.plugin.src/releases) |
| 19 | +2. Extract the ZIP file |
| 20 | +3. Open your browser and navigate to: |
| 21 | + - **Chrome:** `chrome://extensions/` |
| 22 | + - **Edge:** `edge://extensions/` |
| 23 | + - **Brave:** `brave://extensions/` |
| 24 | + - **Opera:** `opera://extensions/` |
| 25 | +4. Enable **Developer mode** (toggle in top-right corner) |
| 26 | +5. Click **Load unpacked** |
| 27 | +6. Select the extracted `chrome` folder |
| 28 | +7. The extension is now installed |
| 29 | + |
| 30 | +### Usage |
| 31 | +- Click the NostrKey icon in your toolbar to open the popup |
| 32 | +- Visit any Nostr web app (e.g., Snort, Primal, Coracle) |
| 33 | +- The app will request permission to use your key |
| 34 | +- Grant or deny permissions as needed |
| 35 | + |
| 36 | +### Troubleshooting |
| 37 | +**Extension not appearing:** |
| 38 | +- Ensure Developer mode is enabled |
| 39 | +- Check that you selected the correct folder (should contain `manifest.json`) |
| 40 | +- Try restarting your browser |
| 41 | + |
| 42 | +**Permission requests not showing:** |
| 43 | +- Check that the extension is enabled in `chrome://extensions/` |
| 44 | +- Verify the website supports NIP-07 |
| 45 | +- Check browser console for errors |
| 46 | + |
| 47 | +--- |
| 48 | + |
| 49 | +## 🧭 Safari (macOS & iOS) |
| 50 | + |
| 51 | +**Supported Platforms:** macOS 11+, iOS 15+ |
| 52 | + |
| 53 | +### Installation from App Store |
| 54 | +*Coming soon to the Mac App Store* |
| 55 | + |
| 56 | +### Manual Installation (macOS) |
| 57 | +1. Download the latest release from [Releases](https://github.com/HumanjavaEnterprises/nostrkey.browser.plugin.src/releases) |
| 58 | +2. Open the `.dmg` file |
| 59 | +3. Drag NostrKey to your Applications folder |
| 60 | +4. Open NostrKey from Applications |
| 61 | +5. In Safari, go to **Safari → Settings → Extensions** |
| 62 | +6. Enable **NostrKey** |
| 63 | +7. Grant necessary permissions |
| 64 | + |
| 65 | +### Manual Installation (iOS) |
| 66 | +1. Install via TestFlight (link coming soon) |
| 67 | +2. Open **Settings → Safari → Extensions** |
| 68 | +3. Enable **NostrKey** |
| 69 | +4. Grant necessary permissions |
| 70 | + |
| 71 | +### Usage |
| 72 | +- **macOS:** Click the NostrKey icon in Safari's toolbar |
| 73 | +- **iOS:** Tap the share button, then tap NostrKey |
| 74 | +- Visit any Nostr web app |
| 75 | +- Approve permission requests as they appear |
| 76 | + |
| 77 | +### Troubleshooting |
| 78 | +**Extension not showing in Safari:** |
| 79 | +- Check Safari → Settings → Extensions |
| 80 | +- Ensure NostrKey is checked/enabled |
| 81 | +- Try quitting and reopening Safari |
| 82 | + |
| 83 | +**iOS extension not appearing:** |
| 84 | +- Go to Settings → Safari → Extensions |
| 85 | +- Make sure NostrKey is toggled on |
| 86 | +- Restart Safari |
| 87 | + |
| 88 | +--- |
| 89 | + |
| 90 | +## 🦊 Firefox |
| 91 | + |
| 92 | +**Status:** Planned for future release |
| 93 | + |
| 94 | +Firefox support is on our roadmap. Follow our [GitHub repository](https://github.com/HumanjavaEnterprises/nostrkey.browser.plugin.src) for updates. |
| 95 | + |
| 96 | +--- |
| 97 | + |
| 98 | +## ⚙️ Getting Started |
| 99 | + |
| 100 | +### First-Time Setup |
| 101 | +1. **Create a Profile:** |
| 102 | + - Click the NostrKey icon |
| 103 | + - Click **Settings** or **Full Settings** |
| 104 | + - Click **New Local** to create a local profile, or **New Bunker** for remote signing |
| 105 | + |
| 106 | +2. **Add Your Key:** |
| 107 | + - **Local Profile:** Paste your `nsec` or hex private key |
| 108 | + - **Bunker Profile:** Paste your `bunker://` connection URL |
| 109 | + - Click **Save** |
| 110 | + |
| 111 | +3. **Configure Relays:** |
| 112 | + - Scroll to the **Relays** section |
| 113 | + - Add your preferred relays (or use recommended ones) |
| 114 | + - Set read/write permissions for each |
| 115 | + |
| 116 | +4. **Set Permissions:** |
| 117 | + - Visit a Nostr web app |
| 118 | + - When prompted, choose **Allow**, **Deny**, or **Ask** for each permission |
| 119 | + - Permissions are saved per-app and can be changed in Settings |
| 120 | + |
| 121 | +### Security Best Practices |
| 122 | +- ✅ **Enable Master Password:** Encrypt your keys at rest |
| 123 | +- ✅ **Backup Your Keys:** Export and securely store your `nsec` |
| 124 | +- ✅ **Use Bunker for High Security:** Keep keys off your device entirely |
| 125 | +- ✅ **Review Permissions Regularly:** Check which apps have access |
| 126 | +- ⚠️ **Never Share Your Private Key:** NostrKey will never ask for it outside the extension |
| 127 | + |
| 128 | +--- |
| 129 | + |
| 130 | +## 🆘 Common Issues |
| 131 | + |
| 132 | +### "Extension cannot access this page" |
| 133 | +Some browsers restrict extensions on certain pages (like `chrome://` or `about:` pages). This is normal browser security. |
| 134 | + |
| 135 | +### "Failed to connect to relay" |
| 136 | +- Check your internet connection |
| 137 | +- Verify the relay URL is correct (must start with `wss://`) |
| 138 | +- Try a different relay from the recommended list |
| 139 | + |
| 140 | +### "Invalid key format" |
| 141 | +- Ensure you're pasting a valid `nsec` (starts with `nsec1`) or hex key |
| 142 | +- Remove any extra spaces or line breaks |
| 143 | +- For encrypted keys, use the ncryptsec import feature |
| 144 | + |
| 145 | +### Keys not syncing between devices |
| 146 | +- NostrKey stores keys locally in each browser |
| 147 | +- To use the same key on multiple devices, manually import it on each |
| 148 | +- Or use nsecBunker for centralized key management |
| 149 | + |
| 150 | +--- |
| 151 | + |
| 152 | +## 📞 Support & Community |
| 153 | + |
| 154 | +- **Issues & Bug Reports:** [GitHub Issues](https://github.com/HumanjavaEnterprises/nostrkey.browser.plugin.src/issues) |
| 155 | +- **Feature Requests:** [GitHub Discussions](https://github.com/HumanjavaEnterprises/nostrkey.browser.plugin.src/discussions) |
| 156 | +- **Documentation:** [docs/](https://github.com/HumanjavaEnterprises/nostrkey.browser.plugin.src/tree/main/docs) |
| 157 | +- **Website:** [humanjava.com](https://humanjava.com) |
| 158 | + |
| 159 | +--- |
| 160 | + |
| 161 | +## 🔒 Privacy & Security |
| 162 | + |
| 163 | +NostrKey is committed to your privacy: |
| 164 | +- ✅ All keys stored locally in your browser |
| 165 | +- ✅ No data sent to external servers (except relays you configure) |
| 166 | +- ✅ Open source and auditable |
| 167 | +- ✅ Optional master password encryption |
| 168 | +- ✅ No tracking or analytics |
| 169 | + |
| 170 | +For full details, see our [Privacy Policy](PRIVACY.md). |
| 171 | + |
| 172 | +--- |
| 173 | + |
| 174 | +## 📄 License |
| 175 | + |
| 176 | +ISC License - See [LICENSE](LICENSE) for details. |
| 177 | + |
| 178 | +**A product by [Humanjava Enterprises Inc](https://humanjava.com)** |
0 commit comments