Skip to content

janoside/lndash

Repository files navigation

LNDash

(Lightning Network Dashboard)

npm version NPM downloads

Admin web interface for LND, via gRPC. Built with Node.js, express, bootstrap-v5.

Live demo: https://lndash.btc21.org

Features

  • UI for connecting to LND - requires host/port/admin.macaroon/tls.cert, which can be supplied in various ways, including using LND Connect strings
  • Browse and search the public lightning network
  • View invoices, payments, and forwarded payments
  • Create and pay invoices
  • Open and close channels
  • Connect to multiple LND nodes and switch between them
  • Simple/intuitive sorting filtering for most data
  • Tools for sign/verify, query route, generate LND Connect strings
  • Star (favorite) nodes and channels
  • Responsive design (but UI is data/table heavy, so works best on large screens)

Getting started

1. Install/Run LND

2. A. Install LNDash (from source)

  • git clone https://github.com/janoside/lndash.git
  • cd lndash; npm install
  • npm start
  • Open http://127.0.0.1:3004/

2. B. Install LNDash as global NPM package

3. Setup LNDash via UI

Once started, LNDash's UI will guide you to set an admin password and then to connect to any LND nodes you're running. Your hashed password and your LND credentials (encrypted with your password), will be stored in the file ~/.lndash/credentials.json. If you restart the app after setup, you'll need to "unlock" with your same admin password (in order to decrypt LND credentials). Deleting this file at any time and restarting will prompt you to go through the setup process again.

Credits

Thanks to inspiration from LND, Joule, RTL, zap desktop, lndash, and lnd-explorer.

Donate