{"id":13569817,"url":"https://github.com/mefatbear/lightning-address-nodejs","last_synced_at":"2025-04-04T06:31:15.520Z","repository":{"id":205932864,"uuid":"432361497","full_name":"mefatbear/lightning-address-nodejs","owner":"mefatbear","description":"Simple server for your personal Lightning Address","archived":false,"fork":false,"pushed_at":"2023-11-07T06:18:20.000Z","size":89,"stargazers_count":15,"open_issues_count":0,"forks_count":3,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-05T02:35:53.139Z","etag":null,"topics":["address","bitcoin","lightning","lightning-network","lightningaddress","lnd","sats","tipping","umbrel"],"latest_commit_sha":null,"homepage":"https://fatbear.me","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mefatbear.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2021-11-27T03:49:17.000Z","updated_at":"2024-09-27T05:54:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"5a70d0d2-a854-4eee-8e03-21a571b07430","html_url":"https://github.com/mefatbear/lightning-address-nodejs","commit_stats":null,"previous_names":["mefatbear/lightning-address-nodejs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mefatbear%2Flightning-address-nodejs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mefatbear%2Flightning-address-nodejs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mefatbear%2Flightning-address-nodejs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mefatbear%2Flightning-address-nodejs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mefatbear","download_url":"https://codeload.github.com/mefatbear/lightning-address-nodejs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247134405,"owners_count":20889396,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["address","bitcoin","lightning","lightning-network","lightningaddress","lnd","sats","tipping","umbrel"],"created_at":"2024-08-01T14:00:44.575Z","updated_at":"2025-04-04T06:31:15.070Z","avatar_url":"https://github.com/mefatbear.png","language":"TypeScript","readme":"# LND Lightning Address\n\nA dead simple [Lightning Address](https://www.lightningaddress.com) server for your personal Lightning Node!\n\nThis will allow your to receive lightning address payments. It's like an email address but for sats!\n\n## What you need\n\n- LND Server\n- Domain Name\n\n## Usage\n\n### Setup Environment Variables\n\n- Create a .env file\n- Find your LND REST Endpoint\n- Generate a Macaroon with Create Invoice permissions\n- Set your LND config. See `.env.sample` for example values\n- Set your domain name\n\n### Start Server\n\n- `docker compose up`\n\n## Config\n\n| Env Var                        | Required | Description                                                                                  |\n| ------------------------------ | -------- | -------------------------------------------------------------------------------------------- |\n| `LNADDR_LND_REST_BASE_URL`     | true     | Your LND REST URL e.g. `https://xxxx.onion:8080` address                                     |\n| `LNADDR_LND_REST_MACAROON_HEX` | true     | Create Invoice Macaroon                                                                      |\n| `LNADDR_DOMAIN`                | true     | Your domain name e.g. `fatbear.me`                                                           |\n| `LNADDR_NOTIFICATION_WEBHOOK`  | false    | Webhook URL to receive notifications when invoices are created. e.g. `https://hookb.in/xxxx` |\n\n## Endpoints\n\n| Endpoint                        | Description        |\n| ------------------------------- | ------------------ |\n| `/`                             | Basic welcome page |\n| `/healthz`                      | Health Check       |\n| `/.well-known/lnurlp/:username` | Lightning Address  |\n\n## Deploy\n\n### Render\n\n[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)\n\nDeploy on [Render](https://render.com/) free tier. You will need to configure you [Custom Domain](https://render.com/docs/custom-domains) after it deploys.\n\nServices on [free plan](https://render.com/docs/free) are automatically spun down after 15 minutes of inactivity. When a new request for a free service comes in, Render spins it up again so it can process the request. This can cause a response delay of up to 30 seconds for the first request that comes in after a period of inactivity.\n\n**Fatbear Pro Tip:** You could setup a cron job on your umbrel to curl the `/healthz` endpoint every ~15 minutes.\n\n## Umbrel\n\nThere are a few additional setups required for this to work on your Umbrel node. That is until [Issue 1082](https://github.com/getumbrel/umbrel/issues/1082) has been resolved.\n\nSTEPS:\n\n1. SSH to your umbrel server `ssh umbrel@umbrel.local` you will need your umbrel password\n2. Find your LND REST browser URL `cat umbrel/tor/data/lnd-rest/hostname`. It have a bunch of characters and end with `.onion`. Prepend `https://` and append `:8080` to this values to get `LNADDR_LND_REST_BASE_URL` env variable.\n3. Open your LND Config File `vim umbrel/lnd/lnd.conf`\n4. Under Application Options add an additional `tlsextradomain` line with your hostname from step 2.\n5. Restart your Umbrel. Can be done from your Umbrel's settings UI.\n\nYour lnd.config should have two `tlsextradomain` lines. e.g.\n\n```\ntlsextradomain=umbrel.local\ntlsextradomain=xxxxxx.onion\n```\n\n## Create Invoice Macaroon\n\nYou will need a HEX encoded macaroon for the `LNADDR_LND_REST_MACAROON_HEX` env variable.\nI highly recommend generating a macaroon with only create invoice permissions. You can use Thunderhub to do this easily.\n\n1. Open Thunderhub\n2. Go to `Tools` in sidebar\n3. Bakery -\u003e Bake Macaroon\n4. Give `Create Invoice` permissions\n5. Hit `Bake new macaroon` button.\n6. Copy the HEX encoded value\n","funding_links":[],"categories":["Applications","TypeScript"],"sub_categories":["Misc"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmefatbear%2Flightning-address-nodejs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmefatbear%2Flightning-address-nodejs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmefatbear%2Flightning-address-nodejs/lists"}