{"id":23133904,"url":"https://github.com/conduition/lnaddrd","last_synced_at":"2025-08-17T09:32:50.908Z","repository":{"id":234840843,"uuid":"789561981","full_name":"conduition/lnaddrd","owner":"conduition","description":"A self-hosted server to provide yourself with a Lightning Address.","archived":false,"fork":false,"pushed_at":"2024-05-13T21:42:29.000Z","size":18,"stargazers_count":5,"open_issues_count":1,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-22T11:07:27.249Z","etag":null,"topics":["bitcoin","lightning-address","lightning-network","lnd","lnurl"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/conduition.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-20T22:38:00.000Z","updated_at":"2024-08-08T02:04:56.000Z","dependencies_parsed_at":"2024-04-21T03:43:27.968Z","dependency_job_id":"9dc1223b-0c1e-4ebd-b702-87d11770ddc2","html_url":"https://github.com/conduition/lnaddrd","commit_stats":null,"previous_names":["conduition/lnaddrd"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conduition%2Flnaddrd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conduition%2Flnaddrd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conduition%2Flnaddrd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/conduition%2Flnaddrd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/conduition","download_url":"https://codeload.github.com/conduition/lnaddrd/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230113667,"owners_count":18175220,"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":["bitcoin","lightning-address","lightning-network","lnd","lnurl"],"created_at":"2024-12-17T12:08:41.478Z","updated_at":"2024-12-17T12:08:42.158Z","avatar_url":"https://github.com/conduition.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# lnaddrd\n\nA self-hosted server to provide yourself with [a Lightning Address](https://lightningaddress.com/), by generating invoices from a remote [LND](https://github.com/lightningnetwork/lnd) instance. No third parties, at all. Just you, your machines, and your money.\n\n## Install\n\nFirst, install the [Golang compiler](https://go.dev).\n\n```sh\ncurl -o - -sL https://go.dev/dl/go1.22.2.linux-amd64.tar.gz | tar xz -C /tmp\nsudo cp -r /tmp/go /usr/local\necho 'export PATH=\"$PATH:/usr/local/go/bin\"' \u003e\u003e ~/.bashrc\nexport PATH=\"$PATH:/usr/local/go/bin\"\ngo version # to confirm install success\n```\n\nNow you can install `lnaddrd` from source:\n\n```sh\ngo install github.com/conduition/lnaddrd@latest\n```\n\n## Usage\n\n`lnaddrd` is quite dumb. It operates with no backend database or state beyond LND itself. It is a simple webserver intended solely to furnish LNURL clients with BOLT11 invoices.\n\nTo configure `lnaddrd`, create a YAML file:\n\n```yaml\n# This configures how the webserver will bind and expose its HTTP stack.\n# By default it serves unencrypted HTTP. Specify a TLS cert+key to serve\n# clients over HTTPS instead.\nwebserver:\n  bind_address: 127.0.0.1:3441              # required\n  # tls_cert_file: /path/to/server.tls.cert # optional\n  # tls_key_file: /path/to/server.tls.key   # optional\n\nlnurl:\n  # This must be the base URL of your server.\n  url_authority: https://conduition.io # required\n\n  # Both of these will be included in the pay request metadata array.\n  # The icon_file can be either a PNG or a JPEG file.\n  short_description: \"Donation to conduition\" # optional\n  icon_file: /path/to/icon.png                # required\n\n  # Determines the range of acceptable payment amounts.\n  max_pay_request_sats: 5_000_000 # required\n  min_pay_request_sats: 100       # required\n\n  # Determines the expiry time of BOLT11 invoices we create.\n  # Defaults to whatever the remote LND instance uses by default.\n  invoice_expiry: \"1h\" # optional\n  # invoice_expiry: \"20m\"\n  # invoice_expiry: \"100s\"\n\n# Accept lightning address requests for the following usernames.\nlightning_address_usernames: # optional\n  - conduition\n\n# Configure a connection to LND's REST API.\n#\n# You can find invoices.macaroon in:     ~/.lnd/data/chain/bitcoin/mainnet/invoices.macaroon\n# You can find LND's TLS certificate in: ~/.lnd/tls.cert\n#\n# Note that your LND certificate MUST have the 'host' field listed as a SAN.\n# (hint: use the 'tlsextradomain' option in lnd.conf)\n#\n# To reach an LND instance running with no-rest-tls,\n# set unsafe_allow_plaintext=true and omit the tls_cert_file parameter.\nlnd:\n  host: conduition.io:8080                  # required\n  macaroon_file: /path/to/invoices.macaroon # required\n  tls_cert_file: /path/to/lnd.tls.cert      # required unless unsafe_allow_plaintext=true\n  unsafe_allow_plaintext: false             # optional\n```\n\nLaunch `lnaddrd` by pointing it at the config file.\n\n```console\n$ lnaddrd /path/to/lnaddrd.yaml\n2024/04/21 02:17:00.560533 starting server on 127.0.0.1:3441\n```\n\nLightning Address HTTP requests will come in at `/.well-known/lnurlp/:username`. The server will only serve responses for usernames which are explicitly listed in the config file.\n\nThe client will be given a callback URL pointing to `\u003curl_authority\u003e/pay/callback/:username`. A request to `\u003curl_authority\u003e/pay/callback/:username?amount=\u003camount\u003e` will cause `lnaddrd` to fetch an invoice from the remote LND instance, which is handed over to the client according to standard LNURL protocols.\n\nThat's it.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconduition%2Flnaddrd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconduition%2Flnaddrd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconduition%2Flnaddrd/lists"}