Hey LNbits community,
We just rolled out a central documentation site for LNbits at docs.lnbits.com a single home that aims to bring every guide, API reference, extension page, and dev resource together under one roof.
Whether you’re a new user trying to spin up your first wallet, an extension developer, or a node operator running LNbits in production â€" the new docs are built to get you to the right page in seconds.
A Cleaner Overview & Menu
The redesigned landing page and side menu give you quick access to every section. Search is fast, navigation is consistent, and every page is cross-linked so you can move from “What is LNbits?” all the way to a working extension or API call without losing your place.
Built for Users, Admins and Developers
We split the documentation into clear tracks so each audience lands exactly where they need:
- Users get plain-language guides for wallets, payments, and using extensions.
- Admins get installation, security, fiat integration, and node-management playbooks.
- Developers get architecture deep dives, extension building, database migration patterns, and a full API reference.
- AI agents & LLMs get their own dedicated section with
llms.txt, MCP server docs, and skill-ready prompts.
Everything is searchable, mobile-friendly, and updated alongside the LNbits codebase.
Full Index Jump Straight to What You Need
Here is the complete list of topics, organized so you can bookmark the ones that matter to you.
Getting Started
Installation & Hosting
- Installation Overview
- Install Script
- Docker Installation
- AppImage
- Poetry Setup
- uv Setup
- Nix Installation
- Fly.io Deployment
- SaaS Hosting
- Node Platforms (Umbrel, Start9, etc.)
- PostgreSQL Setup
- Reverse Proxy Configuration
- Process Manager
- Updating LNbits
Core LNbits
- Admin Dashboard
- Authentication
- Wallets & Accounts
- API Keys
- Payments
- Payment Labels
- LNURL Support
- Notifications
- WebSockets
- Database
- Environment Variables
- Security Best Practices
- Super User
- User Roles
- User Management
- Node Management
- PWA (Progressive Web App)
- Extension Builder
Fiat & Stripe Integration
Backends
Extensions
A few highlights from the extension catalog:
- LNURLp pay links
- Withdraw LNURL withdraw vouchers
- Boltcards NFC Lightning cards
- TPoS point of sale
- SatsPay checkout & invoicing
- Split Payments automatic forwarding
- Paywall gate web content
- Webshop sell products
- Invoices issue and track
- Boltz submarine swaps
- Watch-Only onchain watching
- LNDhub connect mobile wallets
- Nostr Client / Relay / Market / NIP-05
- Scrub auto-forward incoming sats
- TipJar accept tips
- Streamalerts streamer donations
- LNURLDevice hardware integrations
- LNPoS offline-friendly POS
- Bitcoinswitch IoT & switches
- Fossa Lightning ATM
- SatsDice provably fair dice
- Coinflip group payouts
- Auctionhouse auctions over Lightning
- Webpages Lightning-paid pages
and dozens more in the full index.
API Reference
- API Quick Reference
- API Authentication
- Core Wallets API
- Core Payments API
- Core Users API
- Core LNURL API
- Core Extensions API
- Core Fiat API
- Core TinyURL API
- Core WebSockets API
- Admin Settings API
- Admin Users API
- Admin Extensions API
- Admin Topup API
For Developers
- Architecture Overview
- Building Extensions
- Database & Migrations
- Models
- Decorators
- Background Tasks
- Dev Tools
- Wallet Backends (Dev)
- Fiat Integration (Dev)
- Contributing Guide
LLM & Agent Integration
FAQ
Contribute
Tell Us What’s Missing
The docs are a living project if you find a topic that’s unclear, missing, or could use a better example, drop a reply below or open a PR.
Bookmark docs.lnbits.com, share it with anyone learning Lightning & LNbits.
The LNbits Team