https://github.com/riccardobl/nwcprovider
NWC service provider for LNbits
https://github.com/riccardobl/nwcprovider
Last synced: 5 months ago
JSON representation
NWC service provider for LNbits
- Host: GitHub
- URL: https://github.com/riccardobl/nwcprovider
- Owner: riccardobl
- License: mit
- Created: 2024-07-16T15:15:11.000Z (10 months ago)
- Default Branch: master
- Last Pushed: 2024-11-19T19:29:44.000Z (6 months ago)
- Last Synced: 2024-12-22T12:42:38.345Z (5 months ago)
- Language: Python
- Homepage:
- Size: 252 KB
- Stars: 2
- Watchers: 2
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NWC Service Provider Extension for [LNbits](https://github.com/lnbits/lnbits)
Easily connect your LNbits wallets via [NWC](https://nwc.dev/).
## Installation
Install the extension via the .env file or through the admin UI on your LNbits server. More details can be found [here](https://github.com/lnbits/lnbits/wiki/LNbits-Extensions).
## Configuration
Configure the extension from the "Settings" page in the top right menu when logged in as admin inside the extension page.
### Configuration Options:
| Key | Description | Default |
| ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------- |
| relay | URL of the nostr relay for dispatching and receiving NWC events. Use public relays or a custom one. Specify `nostrclient` to connect to the [nostrclient extension](https://github.com/lnbits/nostrclient). | nostrclient |
| provider_key | Nostr secret key of the NWC Service Provider. | Random key generated on install |
| relay_alias | Relay URL to display in pairing URLs. Set if different from `relay`. | Empty (uses the `relay` value) |
### Using Nostrclient
The extension is preconfigured to connect to the nostrclient extension. Install it on the same LNbits instance and configure it to expose public websocket endpoints. Refer to the [nostrclient documentation](https://github.com/lnbits/nostrclient) for more information.
### Using a Custom Relay
To use a custom relay, set the `relay` key to the relay URL (e.g., `wss://nostr.wine`) in the extension's Settings page.
## Usage
1. Go to the extension page.
2. Select a wallet and click the plus button to create a new NWC connection.
3. Configure expiration, limits, and permissions.
4. A pairing URL will be generated for you to open, copy, or scan with the NWC app. Note that the pairing URL is shown only once, but you can delete and recreate the connection to get a new one.