GlcoinCore/alby-hub
1
0
Fork 0
mirror of https://github.com/getAlby/hub.git synced 2026-08-13 12:33:39 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

README

Browse source
This commit is contained in:
Michael Bumann 2023-04-25 15:54:56 +02:00
parent 6b1fa82fab
commit bf0f444feb
1 changed files with 72 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

80
README.md
View file

@ -4,25 +4,34 @@ This service allows you to control your Lightning node or wallet over Nostr.
[Draft NIP](https://github.com/getAlby/nips/blob/master/47.md)
## Configuration parameters
## Supported Backends
For self-hosting with your own node, set the following parameters:
* [Alby](https://getalby.com)
* LND
## Configuration parameters
- `NOSTR_PRIVKEY`: the private key of this service. Should be a securely randomly generated 32 byte hex string.
- `CLIENT_NOSTR_PUBKEY`: if set, this service will only listen to events authored by this public key. You can set this to your own nostr public key.
- `RELAY`: default: "wss://relay.getalby.com/v1"
- `LN_BACKEND_TYPE`: should be set to `LND`
- `LND_ADDRESS`: the LND gRPC address, eg. `localhost:10009`
- `LND_CERT_FILE`: the location where LND's `tls.cert` file can be found
- `LND_MACAROON_FILE`: the location where LND's `admin.macaroon` file can be found
- `LN_BACKEND_TYPE`: ALBY or LND
- `ALBY_CLIENT_SECRET`= Alby OAuth client secret (used with the Alby backend)
- `ALBY_CLIENT_ID`= Alby OAuth client ID (used with the Alby backend)
- `OAUTH_REDIRECT_URL`= OAuth redirect URL (e.g. http://localhost:8080/alby/callback) (used with the Alby backend)
- `LND_ADDRESS`: the LND gRPC address, eg. `localhost:10009` (used with the LND backend)
- `LND_CERT_FILE`: the location where LND's `tls.cert` file can be found (used with the LND backend)
- `LND_MACAROON_FILE`: the location where LND's `admin.macaroon` file can be found (used with the LND backend)
- `COOKIE_SECRET`: a randomly generated secret string.
- `DATABASE_URI`: a postgres connection string or sqlite filename. Default: nostr-wallet-connect.db (sqlite)
- `PORT`: the port on which the app should listen on (default: 8080)
## Installation
`cp .env.example .env`
$ cp .env.example .env
# edit the config for your needs
vim .env
add `NOSTR_PRIVKEY`, `ALBY_CLIENT_SECRET`, `ALBY_CLIENT_ID` to .env
To get a new random Nostr key use `openssl rand -hex 32` or similar.
## Development
@ -31,3 +40,58 @@ add `NOSTR_PRIVKEY`, `ALBY_CLIENT_SECRET`, `ALBY_CLIENT_ID` to .env
To build the CSS run:
`npx tailwindcss -i ./views/application.css -o ./public/css/application.css --watch`
## /apps/new deeplink options
Clients can use a deeplink to allow the user to add a new connection. Depending on the client this URL has different query options:
### NWC created secret
The default option is that the NWC app creates a secret and the user uses the nostr wallet connect URL string to enable the client application.
#### Query parameter options
- `c`: the name of the client app
Example:
`/apps/new?c=myapp`
### Client created secret
If the client creates the secret the client only needs to share the public key of that secret for authorization. The user authorized that pubkey and no sensitivate data needs to be shared.
#### Query parameter options
- `c`: the name of the client app
- `pubkey`: the public key of the client's secret for the user to authorize
- `return_to`: (optional) if a `return_to` URL is provided the user will be redirected to that URL after authorization
Example:
`/apps/new?c=myapp&pubkey=47c5a21...&return_to=https://example.com`
### Web-flow: client created secret
Web clients can open a new prompt popup to load the authorization page.
Once the user has authorized the app connection a `nwc:success` message is sent to the opening page (using `postMessage`) to indicate that the connection is authorized. See the `initNWC()` function in the [alby-js-sdk](https://github.com/getAlby/alby-js-sdk#nostr-wallet-connect-documentation)
Example:
```js
import { webln } from "alby-js-sdk";
const nwc = new webln.NWC();
// initNWC opens a prompt with /apps/new?c=myapp&pubkey=xxxx
// the promise resolves once the user has authorized the connection (when the `nwc:success` message is received) and the popup is closed automatically
// the promise rejects if the user cancels by closing the prompt popup
await nwc.initNWC({name: 'myapp'});
````
## Help
If you need help contact hello@getalby.com or reach out on Nostr: npub1getal6ykt05fsz5nqu4uld09nfj3y3qxmv8crys4aeut53unfvlqr80nfm
## ⚡️Donations
Want to support the work on Alby?
Support the Alby team ⚡️hello@getalby.com
You can also contribute to our [bounty program](https://github.com/getAlby/lightning-browser-extension/wiki/Bounties): ⚡️bounties@getalby.com