Skip to content

Installation

Jump to bottom
WoompaLoompa edited this page Aug 9, 2026 · 13 revisions

Installation

Requirements

  • LNbits >= 1.0.0 (min_lnbits_version is set to 1.0.0)
  • Python >= 3.10
  • A working Lightning backend configured in LNbits (for the extension's wallet backend). See Lightning backends below.
  • Network access to the Nostr relays you configure (wss://…).

The extension adds no new Python dependencies. It reuses LNbits' bundled coincurve, websockets, and bech32 packages and LNbits' own Nostr utilities (lnbits.utils.nostr).

Installing

Option A — official release (once v0.1.0 is published)

When the extension reaches v0.1.0 it will be installable from the LNbits extension manager:

  1. Log in to LNbits.
  2. Open Extensions and enable CLINK for your user.
  3. The extension appears under CLINK in the sidebar.

The release pipeline automatically publishes GitHub releases and opens a pull request to the official lnbits/lnbits-extensions registry.

Option B — manual install (from the repository)

Until a release tag exists you can install the extension by placing the code in LNbits' extensions directory:

# Inside the LNbits app folder
cd extensions
git clone https://github.com/WoompaLoompa/lnbits-clink.git clink

The folder must be named clink — LNbits derives the extension id from the folder name and imports it as the clink Python package. (The repository is named lnbits-clink only because GitHub disallows single-word lowercase repo names.)

Then restart LNbits, enable the extension for your user, and you're done.

Configuration

The extension has no environment variables of its own. It is a plain LNbits extension:

  • Backend wallet: it uses whatever wallet backend LNbits is configured with (LNBITS_BACKEND_WALLET_CLASS). The public checkout, debit settlement, and subscriptions all call create_invoice/pay_invoice on that backend.
  • First relay: you add relays from the UI or the API (/clink/api/v1/relays). Nothing works until at least one relay is enabled.

Lightning backend

For a real end-to-end experience (actually creating and paying Lightning invoices) you need a real Lightning backend such as:

  • LND (LNDWallet)
  • Core Lightning (CoreLightningWallet)
  • Eclair (EclairWallet)
  • A remote service such as Alby (AlbyWallet)

The default VoidWallet backend reports "cannot create invoices" — it is only useful for exercising the protocol layer, not for payments.

Verifying the install

# List enabled relays (public info endpoint)
curl https://<your-lnbits>/clink/api/v1/info

You should see the relay list and "listener": {"enabled": true} once a relay is added and the LNbits background task is running.

lnbits-clink — CLINK (Nostr-native Lightning) for LNbits.

Clone this wiki locally