-
-
+
](https://t.me/lnbits) [
](https://opensats.org)
-](https://t.me/lnbits) [](https://opensats.org)
+
-# LNbits — The most powerful Bitcoin & Lightning toolkit
+# The world's most powerful suite of bitcoin tools.
-> Run it for yourself, for your community, or as part of a larger stack.
+## Run for yourself, for others, or as part of a stack.
-## What is LNbits?
+LNbits is beta, for responsible disclosure of any concerns please contact an admin in the community chat.
-LNbits is a lightweight Python server that sits on top of your Lightning funding source. It gives you safe, isolated wallets, a clean API, and an extension system for rapidly adding features - without locking you into a single node implementation. The Inspiration for LNBits came from ideas pioneered by **OpenNode** and **LNPay** — both today work as funding sources for LNbits.
+LNbits is a Python server that sits on top of any funding source. It can be used as:
-## What you can do with LNbits
+- Accounts system to mitigate the risk of exposing applications to your full balance via unique API keys for each wallet
+- Extendable platform for exploring Lightning network functionality via the LNbits extension framework
+- Part of a development stack via LNbits API
+- Fallback wallet for the LNURL scheme
+- Instant wallet for LN demonstrations
-- **Harden app security:** Create per-wallet API keys so individual apps never touch your full balance.
-- **Extend functionality fast:** Install extensions to explore and ship Lightning features with minimal code.
-- **Build into your stack:** Use the LNbits HTTP API to integrate payments, wallets, and accounting.
-- **Cover LNURL flows:** Use LNbits as a reliable fallback wallet for LNURL.
-- **Demo in minutes:** Spin up instant wallets for workshops, proofs-of-concept, and user testing.
+LNbits can run on top of almost all Lightning funding sources.
-## Funding sources
+See [LNbits manual](https://docs.lnbits.org/guide/wallets.html) for more detailed documentation about each funding source.
-LNbits runs on top of most Lightning backends. Choose the one you already operate - or swap later without changing your app architecture.
+Checkout the LNbits [YouTube](https://www.youtube.com/playlist?list=PLPj3KCksGbSYG0ciIQUWJru1dWstPHshe) video series.
-- Read the [funding source guide](https://docs.lnbits.org/guide/wallets.html)
-
-## Learn more
-
-- Video series on [Youtube](https://www.youtube.com/@lnbits)
-- Introduction Video [LNBits V1](https://www.youtube.com/watch?v=PFAHKxvgI9Y&t=19s)
+LNbits is inspired by all the great work of [opennode.com](https://www.opennode.com/), and in particular [lnpay.co](https://lnpay.co/). Both work as funding sources for LNbits.
## Running LNbits
-See the [install guide](https://github.com/lnbits/lnbits/blob/main/docs/guide/installation.md) for details on installation and setup.
+Test on our demo server [demo.lnbits.com](https://demo.lnbits.com), or on [lnbits.com](https://lnbits.com) software as a service, where you can spin up an LNbits instance for 21sats per hr.
-Get yourself familiar and test on our demo server [demo.lnbits.com](https://demo.lnbits.com), or on [lnbits.com](https://lnbits.com) software as a service, where you can spin up an LNbits instance for 21sats per hr.
+See the [install guide](https://github.com/lnbits/lnbits/blob/main/docs/guide/installation.md) for details on installation and setup.
## LNbits account system
@@ -74,15 +66,9 @@ As well as working great in a browser, LNbits has native IoS and Android apps as
-## Powered by LNbits
+## Tip us
-LNbits empowers everyone with modular, open-source tools for building Bitcoin-based systems — fast, free, and extendable.
-
-[](https://shop.lnbits.com/)
-[](https://shop.lnbits.com/)
-[](https://my.lnbits.com/login)
-[](https://news.lnbits.com/)
-[](https://extensions.lnbits.com/) [](https://demo.lnbits.com/tipjar/DwaUiE4kBX6mUW6pj3X5Kg)
+If you like this project [send some tip love](https://demo.lnbits.com/lnurlp/link/fH59GD)!
[docs]: https://github.com/lnbits/lnbits/wiki
[docs-badge]: https://img.shields.io/badge/docs-lnbits.org-673ab7.svg
diff --git a/docs/_config.yml b/docs/_config.yml
index 6373311c..75ddd399 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -4,7 +4,6 @@ color_scheme: dark
logo: "/logos/lnbits-full-inverse.png"
search_enabled: true
url: https://docs.lnbits.org
-markdown: gfm
aux_links:
"LNbits on GitHub":
- "//github.com/lnbits/lnbits"
diff --git a/docs/guide/admin_ui.md b/docs/guide/admin_ui.md
index f71019a2..f732d9e5 100644
--- a/docs/guide/admin_ui.md
+++ b/docs/guide/admin_ui.md
@@ -1,134 +1,78 @@
---
layout: default
title: Admin UI
-nav_order: 1
+nav_order: 4
---
-
-
- ](https://t.me/lnbits)
-[](https://opensats.org)
+The LNbits Admin UI lets you change LNbits settings via the LNbits frontend.
+It is disabled by default and the first time you set the environment variable `LNBITS_ADMIN_UI=true`
+the settings are initialized and saved to the database and will be used from there as long the UI is enabled.
+From there on the settings from the database are used.
-# LNBits Admin UI
+# Super User
-[What you can do](#what-you-can-do-with-the-admin-ui) · [First Run](#first-run-and-super-user-id) · [Enable/Disable](#enabling-or-disabling-the-admin-ui) · [Reset](#reset-to-defaults) · [Allowed Users](#allowed-users) · [Guides](#additional-guides)
+With the Admin UI we introduced the super user, it is created with the initialisation of the Admin UI and will be shown with a success message in the server logs.
+The super user has access to the server and can change settings that may crash the server and make it unresponsive via the frontend and api, like changing funding sources.
-**We introduced the Admin UI as the new default to make setup simpler and more straightforward**. Instead of hand editing the `.env` file, you configure key server settings directly in the frontend with clear labels and guardrails.
+Also only the super user can brrrr satoshis to different wallets.
-On a fresh install the Admin UI is enabled by default, and at first launch you are prompted to create **Super User** credentials so that sensitive operations, such as switching funding sources, remain in trusted hands. When the Admin UI is enabled, configuration is written to and read from the database; for all settings managed by the UI, the parameters in `.env` are largely no longer used. If you disable the Admin UI, the `.env` file becomes the single source of truth again.
+The super user is only stored inside the settings table of the database and after the settings are "reset to defaults" and a restart happened,
+a new super user is created.
-For privileged actions and role details see **[Super User](./super_user.md)** & [User Roles](./user_roles.md)
-For a complete reference of legacy variables consult **[.env.example](../../.env.example)**.
+The super user is never sent over the api and the frontend only receives a bool if you are super user or not.
-
- ](https://t.me/lnbits)
-[](https://opensats.org)
+There may be trade-offs between the funding sources used, for example funding LNbits using Strike requires the user to KYC themselves and has some
+privacy compromises versus running your own LND node. However the technical barrier to entry of using Strike is lower than using LND.
-# Backend Wallet Comparison Table
-
-LNbits lets you choose **how your wallets are funded** — from fully self-custodial nodes to simple hosted services. You can switch the funding source **without touching your apps, users, or extensions**. That means you can start fast, learn, and later upgrade to more control and privacy when you are ready.
-
-**Why this matters**
-
-- **Flexibility:** Pick the backend that fits your skills and constraints today, change it later with minimal friction.
-- **Speed to ship:** Use a hosted option to get live quickly; move to a node when you need more control.
-- **Scalability:** Match cost and maintenance to your stage — from hobby to production.
-- **Privacy and compliance:** Choose between self-custody and provider-managed options depending on your requirements.
-
-Below is a side-by-side comparison of Lightning funding sources you can use with LNbits.
-
-> [!NOTE]
-> “Backend Wallet” and “Funding Source” mean the same thing — the wallet or service that funds your LNbits.
+The table below offers a comparison of the different Lightning Network funding sources that can be used with LNbits.
## LNbits Lightning Network Funding Sources Comparison Table
-| **Funding Source** | **Custodial Type** | **KYC Required** | **Technical Knowledge Needed** | **Node Hosting Required** | **Privacy Level** | **Liquidity Management** | **Ease of Setup** | **Maintenance Effort** | **Cost Implications** | **Scalability** | **Notes** |
-| ------------------------------ | ------------------------ | ------------------- | ------------------------------ | ------------------------- | ----------------- | ------------------------ | ----------------- | ---------------------- | -------------------------------------------- | --------------- | ------------------------------------------------------------------------------------------ |
-| **LND (gRPC)** | Self-custodial | ❌ | Higher | ✅ | High | Manual | Moderate | High | Infrastructure cost and channel opening fees | High | gRPC interface for LND; suitable for advanced integrations. |
-| **CoreLightning (CLN)** | Self-custodial | ❌ | Higher | ✅ | High | Manual | Moderate | High | Infrastructure cost and channel opening fees | High | Requires setting up and managing your own CLN node. |
-| **Phoenixd** | Self-custodial | ❌ | Medium | ❌ | Medium | Automatic | Moderate | Low | Minimal fees | Medium | Mobile wallet backend; suitable for mobile integrations. |
-| **Nostr Wallet Connect (NWC)** | Custodial | Depends on provider | Low | ❌ | Variable | Provider-managed | Easy | Low | May incur fees | Medium | Connects via Nostr protocol; depends on provider's policies. |
-| **Boltz** | Self-custodial | ❌ | Medium | ❌ | Medium | Provider-managed | Moderate | Moderate | Minimal fees | Medium | Uses submarine swaps; connects to Boltz client. |
-| **LND (REST)** | Self-custodial | ❌ | Higher | ✅ | High | Manual | Moderate | High | Infrastructure cost and channel opening fees | High | REST interface for LND; suitable for web integrations. |
-| **CoreLightning REST** | Self-custodial | ❌ | Higher | ✅ | High | Manual | Moderate | High | Infrastructure cost and channel opening fees | High | REST interface for CLN; suitable for web integrations. |
-| **LNbits (another instance)** | Custodial | Depends on host | Low | ❌ | Variable | Provider-managed | Easy | Low | May incur hosting fees | Medium | Connects to another LNbits instance; depends on host's policies. |
-| **Alby** | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Browser extension wallet; suitable for web users. |
-| **Breez SDK** | Self-custodial | ❌ | Medium | ❌ | High | Automatic | Moderate | Low | Minimal fees | Medium | SDK for integrating Breez wallet functionalities. |
-| **OpenNode** | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Third-party service; suitable for merchants. |
-| **Blink** | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Third-party service; focuses on mobile integrations. |
-| **ZBD** | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Gaming-focused payment platform. |
-| **Spark (CLN)** | Self-custodial | ❌ | Higher | ✅ | High | Manual | Moderate | High | Infrastructure cost and channel opening fees | High | Web interface for CLN; requires Spark server setup. |
-| **Cliche Wallet** | Self-custodial | ❌ | Medium | ❌ | Medium | Manual | Moderate | Moderate | Minimal fees | Medium | Lightweight wallet; suitable for embedded systems. |
-| **Strike** | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Third-party service; suitable for quick setups. |
-| **LNPay** | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Third-party service; suitable for quick setups. |
-| **Eclair (ACINQ)** | Self-custodial | ❌ | Higher | ✅ | High | Manual | Moderate | High | Infrastructure cost and channel opening fees | High | Connects via API; you run and manage your Eclair node. |
-| **LN.tips** | Custodial/Self-Custodial | Depends on provider | Medium | ❌ | Low | Provider-managed | Moderate | Low | Transaction fees may apply | Medium | Simple hosted service; use LN.tips API as your backend. |
-| **Fake Wallet** | Testing (simulated) | ❌ | Low | ❌ | N/A | N/A | Easy | Low | None (test only) | N/A | For testing only; mints accounting units in LNbits (no real sats, unit name configurable). |
-
----
-
-### Notes for readers
-
-- These are typical characteristics; your exact experience may vary by configuration and provider policy.
-- Pick based on your constraints: compliance (KYC), privacy, ops effort, and time-to-ship.
-
----
-
-## Additional Guides
-
-- **[Admin UI](./admin_ui.md)** — Manage server settings via a clean UI (avoid editing `.env` by hand).
-- **[User Roles](./User_Roles.md)** — Quick Overview of existing Roles in LNBits.
-- **[Funding sources](./funding-sources_table.md)** — What’s available and how to enable/configure each.
-
-## Powered by LNbits
-
-LNbits empowers everyone with modular, open-source tools for building Bitcoin-based systems — fast, free, and extendable.
-
-If you like this project, [send some tip love](https://demo.lnbits.com/tipjar/DwaUiE4kBX6mUW6pj3X5Kg) or visit our [Shop](https://shop.lnbits.de)
-
-[](https://shop.lnbits.com/)
-[](https://shop.lnbits.com/)
-[](https://my.lnbits.com/login)
-[](https://news.lnbits.com/)
-[](https://extensions.lnbits.com/)
+| **Funding Source** | **Custodial Type** | **KYC Required** | **Technical Knowledge Needed** | **Node Hosting Required** | **Privacy Level** | **Liquidity Management** | **Ease of Setup** | **Maintenance Effort** | **Cost Implications** | **Scalability** | **Notes** |
+| -------------------------- | ------------------ | ------------------- | ------------------------------ | ------------------------- | ----------------- | ------------------------ | ----------------- | ---------------------- | -------------------------------------------- | --------------- | ---------------------------------------------------------------- |
+| LND (gRPC) | Self-custodial | ❌ | Higher | ✅ | High | Manual | Moderate | High | Infrastructure cost and channel opening fees | High | gRPC interface for LND; suitable for advanced integrations. |
+| CoreLightning (CLN) | Self-custodial | ❌ | Higher | ✅ | High | Manual | Moderate | High | Infrastructure cost and channel opening fees | High | Requires setting up and managing your own CLN node. |
+| Phoenixd | Self-custodial | ❌ | Medium | ❌ | Medium | Automatic | Moderate | Low | Minimal fees | Medium | Mobile wallet backend; suitable for mobile integrations. |
+| Nostr Wallet Connect (NWC) | Custodial | Depends on provider | Low | ❌ | Variable | Provider-managed | Easy | Low | May incur fees | Medium | Connects via Nostr protocol; depends on provider's policies. |
+| Boltz | Self-custodial | ❌ | Medium | ❌ | Medium | Provider-managed | Moderate | Moderate | Minimal fees | Medium | Uses submarine swaps; connects to Boltz client. |
+| LND (REST) | Self-custodial | ❌ | Higher | ✅ | High | Manual | Moderate | High | Infrastructure cost and channel opening fees | High | REST interface for LND; suitable for web integrations. |
+| CoreLightning REST | Self-custodial | ❌ | Higher | ✅ | High | Manual | Moderate | High | Infrastructure cost and channel opening fees | High | REST interface for CLN; suitable for web integrations. |
+| LNbits (another instance) | Custodial | Depends on host | Low | ❌ | Variable | Provider-managed | Easy | Low | May incur hosting fees | Medium | Connects to another LNbits instance; depends on host's policies. |
+| Alby | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Browser extension wallet; suitable for web users. |
+| Breez SDK | Self-custodial | ❌ | Medium | ❌ | High | Automatic | Moderate | Low | Minimal fees | Medium | SDK for integrating Breez wallet functionalities. |
+| OpenNode | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Third-party service; suitable for merchants. |
+| Blink | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Third-party service; focuses on mobile integrations. |
+| ZBD | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Gaming-focused payment platform. |
+| Spark (CLN) | Self-custodial | ❌ | Higher | ✅ | High | Manual | Moderate | High | Infrastructure cost and channel opening fees | High | Web interface for CLN; requires Spark server setup. |
+| Cliche Wallet | Self-custodial | ❌ | Medium | ❌ | Medium | Manual | Moderate | Moderate | Minimal fees | Medium | Lightweight wallet; suitable for embedded systems. |
+| Strike | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Third-party service; suitable for quick setups. |
+| LNPay | Custodial | ✅ | Low | ❌ | Low | Provider-managed | Easy | Low | Transaction fees apply | Medium | Third-party service; suitable for quick setups. |
diff --git a/docs/guide/installation.md b/docs/guide/installation.md
index 4e4e08b6..cbe8d7a4 100644
--- a/docs/guide/installation.md
+++ b/docs/guide/installation.md
@@ -1,51 +1,18 @@
---
layout: default
-title: Installation
-nav_order: 1
+title: Basic installation
+nav_order: 2
---
-
-
- ](https://t.me/lnbits)
-
# Basic installation
-> [!NOTE]
-> **Default DB:** LNbits uses SQLite by default (simple & effective). You can switch to PostgreSQL — see the section below.
+Note that by default LNbits uses SQLite as its database, which is simple and effective but you can configure it to use PostgreSQL instead which is also described in a section below.
-## Table of contents
+## Option 1: AppImage (LInux)
-- [Option 1: AppImage (Linux)](#option-1-appimage-linux)
-- [Option 2: UV (recommended for developers)](#option-2-uv-recommended-for-developers)
-- [Option 2a (Legacy): Poetry — Replaced by UV](#option-2a-legacy-poetry--replaced-by-uv)
-- [Option 3: Install script (Debian/Ubuntu)](#option-3-install-script-debianubuntu)
-- [Option 4: Nix](#option-4-nix)
-- [Option 5: Docker](#option-5-docker)
-- [Option 6: Fly.io](#option-6-flyio)
-- [Troubleshooting](#troubleshooting)
-- [Optional: PostgreSQL database](#optional-postgresql-database)
-- [Using LNbits](#using-lnbits)
-- [Additional guides](#additional-guides)
- - [Update LNbits (all methods)](#update-lnbits-all-methods)
- - [SQLite → PostgreSQL migration](#sqlite--postgresql-migration)
- - [LNbits as a systemd service](#lnbits-as-a-systemd-service)
- - [Reverse proxy with automatic HTTPS (Caddy)](#reverse-proxy-with-automatic-https-caddy)
- - [Apache2 reverse proxy over HTTPS](#apache2-reverse-proxy-over-https)
- - [Nginx reverse proxy over HTTPS](#nginx-reverse-proxy-over-https)
- - [HTTPS without a reverse proxy (self-signed)](#https-without-a-reverse-proxy-self-signed)
- - [LNbits on Umbrel behind Tor](#lnbits-on-umbrel-behind-tor)
- - [FreeBSD notes](#freebsd-notes)
+### AppImage (Linux)
-## Option 1: AppImage (Linux)
-
-**Quickstart**
-
-1. Download latest AppImage from [releases](https://github.com/lnbits/lnbits/releases) **or** run:
+Go to [releases](https://github.com/lnbits/lnbits/releases) and pull latest AppImage, or:
```sh
sudo apt-get install jq libfuse2
@@ -54,19 +21,19 @@ chmod +x LNbits-latest.AppImage
LNBITS_ADMIN_UI=true HOST=0.0.0.0 PORT=5000 ./LNbits-latest.AppImage # most system settings are now in the admin UI, but pass additional .env variables here
```
-- LNbits will create a folder for DB and extension files **in the same directory** as the AppImage.
-
-> [!NOTE]
-> **Next steps**
-> Install complete → **[Running LNbits](#run-the-server)**
-> Update LNBits → **[Update LNbits (all methods)](#update-lnbits-all-methods)**
+LNbits will create a folder for db and extension files in the folder the AppImage runs from.
## Option 2: UV (recommended for developers)
-> [!IMPORTANT]
-> **It is recommended to use the latest version of UV & Make sure you have Python version 3.12 installed.**
+It is recommended to use the latest version of UV. Make sure you have Python version `3.12` installed.
-### Verify Python
+### Install Python 3.12
+
+## Option 2 (recommended): UV
+
+It is recommended to use the latest version of UV. Make sure you have Python version 3.10 or higher installed.
+
+### Verify Python version
```sh
python3 --version
@@ -79,86 +46,26 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
export PATH="$HOME/.local/bin:$PATH"
```
-### Install LNbits
-
-```sh
-git clone https://github.com/lnbits/lnbits.git
-cd lnbits
-git checkout main
-uv sync --all-extras
-
-cp .env.example .env
-# Optional: set funding source and other options in .env (e.g., `nano .env`)
-```
-
-### Run the server
-
-```sh
-uv run lnbits
-# To change port/host: uv run lnbits --port 9000 --host 0.0.0.0
-# Add --debug to the command above and set DEBUG=true in .env for verbose output
-```
-
-### LNbits CLI
-
-```sh
-# Useful for superuser ID, updating extensions, etc.
-uv run lnbits-cli --help
-```
-
-### Update LNbits
-
-```sh
-cd lnbits
-# Stop LNbits with Ctrl + X or your service manager
-# sudo systemctl stop lnbits
-
-# Update code
-git pull --rebase
-
-uv sync --all-extras
-uv run lnbits
-```
-
-#### Use Admin UI → Extensions → "Update All" to bring extensions up to the proper level
-
-> [!NOTE]
-> **Next steps**
-> Install complete → **[Running LNbits](#run-the-server)**
-> Update LNBits → **[Update LNbits (all methods)](#update-lnbits-all-methods)**
-
-## Option 2a (Legacy): Poetry — _Replaced by UV_
-
-
- ](https://t.me/lnbits)
-[](https://opensats.org)
-
-# LNbits Super User (SU)
-
-**Table of Contents**
-
-- [What is the Super User?](#what-is-the-super-user)
-- [When is the Super User created?](#when-is-the-super-user-created)
-- [Disabeling the Admin UI](#disabeling-the-admin-ui)
-- [Super User identity and storage](#super-user-identity-and-storage)
-- [Security model since v1](#security-model-since-v1)
-- [Admin vs Super User](#admin-vs-super-user)
-- [Operational guidance](#operational-guidance)
-- [Additional guides](#additional-guides)
-
-
- ](https://t.me/lnbits)
-[](https://opensats.org)
-
-# LNbits Roles: A Quick Overview
-
-### Understand **who can do what** in seconds: `Super User`, `Admin`, and `Regular User`.
-
-**Jump to:**
-[Roles at a Glance](#roles-at-a-glance) •
-[Super User](#super-user--master-control) •
-[Admin](#admin--day-to-day-manager) •
-[Regular User](#regular-user--everyday-use) •
-[Best Practices](#best-practices) •
-[Additional Guides](#additional-guides)
-
----
-
-## Roles at a Glance
-
-| Capability | **Super User** (owner) | **Admin** (manager) | **Regular User** (end user) |
-| -------------------------------- | :--------------------: | :-----------------: | :-------------------------: |
-| Change **funding source** | ✅ | ❌ | ❌ |
-| Credit/Debit any wallet | ✅ | ❌ | ❌ |
-| Manage Admins & Users | ✅ | ✅ | ❌ |
-| Enable/disable extensions | ✅ | ✅ | ❌ |
-| Use wallets & allowed extensions | ✅ | ✅ | ✅ |
-
-> **Plain talk:** **Super User** = Owner • **Admin** = Trusted manager • **Regular User** = End user
-
-## Role Snapshots
-
-### Super User — Master Control
-
-For initial setup and rare, high-impact changes.
-
-- Configure **server-level settings** (e.g., funding source).
-- **Credit/Debit** any wallet.
-- Create and manage initial **Admin(s)**.
-
-> **Sign-in:** username + password (v1+). The old query-string login is retired.
-
-### Admin — Day-to-Day Manager
-
-For running the service without touching the most sensitive knobs.
-
-- Manage **Users**, **Admins**, and **Extensions** in the Admin UI.
-- Adjust security-related settings (e.g., `rate_limiter`, `ip_blocker`).
-- Handle operations settings (e.g., `service_fee`, `invoice_expiry`).
-- Build brand design in **Site Customization**.
-- Update user accounts.
-
-**Typical tasks:** onboarding users, enabling extensions, tidying wallets, reviewing activity.
-
-> **Sign-in:** username + password (v1+). The old query-string login is retired.
-
-### Regular User — Everyday Use
-
-For using LNbits, not administering it.
-
-- Access **personal wallets** and **allowed extensions**.
-- No server/admin privileges.
-
-**Typical tasks:** receive and send payments, use enabled extensions.
-
-## Best Practices
-
-- **Minimize risk:** Reserve **Super User** for rare, sensitive actions (funding source, debit/credit). Use **Admin** for daily operations.
-- **Keep access tidy:** Review your Admin list occasionally; remove unused accounts.
-- **Change management:** Test risky changes (like funding) in a staging setup first.
-
-## Additional Guides
-
-- **[Admin UI](./admin_ui.md)** — Manage server settings via a clean UI (avoid editing `.env` by hand).
-- **[Super User](./super_user.md)** — Deep dive on responsibilities and safe usage patterns.
-- **[Funding sources](./funding-sources-table.md)** — What’s available and how to enable/configure each.
-
-## Powered by LNbits
-
-LNbits empowers everyone with modular, open-source tools for building Bitcoin-based systems—fast, free, and extendable.
-
-If you like this project, [send some tip love](https://demo.lnbits.com/tipjar/DwaUiE4kBX6mUW6pj3X5Kg) or visit our [Shop](https://shop.lnbits.de)
-
-[](https://shop.lnbits.com/)
-[](https://shop.lnbits.com/)
-[](https://my.lnbits.com/login)
-[](https://news.lnbits.com/)
-[](https://extensions.lnbits.com/)
diff --git a/docs/guide/wallets.md b/docs/guide/wallets.md
index 51275a5e..00f5d5ef 100644
--- a/docs/guide/wallets.md
+++ b/docs/guide/wallets.md
@@ -4,367 +4,177 @@ title: Backend wallets
nav_order: 3
---
-
-
- ](https://t.me/lnbits)
-[](https://opensats.org)
-
# Backend wallets
-**LNbits is modular**: You can switch the funding source (backend wallet) **without changing anything else** in your setup. Keep your extensions, apps, users, and config as-is — just point LNbits to a different backend via environment variables.
+LNbits can run on top of many Lightning Network funding sources with more being added regularly.
-**What stays the same when you switch backends**
+A backend wallet can be configured using the following LNbits environment variables:
-- Your LNbits setup and extensions
-- Your API keys and endpoints
-- Your server and deployment setup
-
-A backend wallet is selected and configured entirely through LNbits environment variables. See the options and variables below, and compare them here: [Funding-Source-Table.md](funding-sources-table.md)
-
-> [!NOTE]
-> **Terminology:** “Backend Wallet” and “Funding Source” mean the same thing — the wallet or service that funds your LNbits.
-
-## Funding Sources
-
-## Funding Sources
-
-| | | |
-| ----------------------------------------------- | ------------------------------------- | ------------------------------------------------- |
-| [CLNRest (runes)](#clnrest-runes) | [LND (REST)](#lnd-rest) | [OpenNode](#opennode) |
-| [CoreLightning](#corelightning) | [LND (gRPC)](#lnd-grpc) | [Blink](#blink) |
-| [CoreLightning REST](#corelightning-rest) | [LNbits](#lnbits) | [Alby](#alby) |
-| [Spark (Core Lightning)](#spark-core-lightning) | [LNPay](#lnpay) | [Boltz](#boltz) |
-| [Cliche Wallet](#cliche-wallet) | [ZBD](#zbd) | [Phoenixd](#phoenixd) |
-| [Breez SDK](#breez-sdk) | [Breez Liquid SDK](#breez-liquid-sdk) | [Nostr Wallet Connect](#nostr-wallet-connect-nwc) |
-| [Strike](#strike) | [Eclair (ACINQ)](#eclair-acinq) | [LN.tips](#lntips) |
-| [Fake Wallet](#fake-wallet) | | |
-
----
-
-
+You can [compare the LNbits compatible Lightning Network funding sources here](wallets.md).
### CLNRest (using [runes](https://docs.corelightning.org/reference/lightning-createrune))
-[Core Lightning REST API docs](https://docs.corelightning.org/docs/rest)
+[Core lightning Rest API docs](https://docs.corelightning.org/docs/rest)
+
Should also work with the [Rust version of CLNRest](https://github.com/daywalker90/clnrest-rs)
-**Environment variables**
-
-- `LNBITS_BACKEND_WALLET_CLASS`: `CLNRestWallet`
+- `LNBITS_BACKEND_WALLET_CLASS`: **CLNRestWallet**
- `CLNREST_URL`: `https://127.0.0.1:3010`
-- `CLNREST_CA`: `/home/lightningd/.lightning/bitcoin/ca.pem` (or the content of the file)
-- `CLNREST_CERT`: `/home/lightningd/.lightning/bitcoin/server.pem` (or the content of the file)
-- `CLNREST_LAST_PAY_INDEX`: `lightning-cli listinvoices | jq -r '.invoices | map(.created_index) | max'`
+- `CLNREST_CA`: `/home/lightningd/.lightning/bitcoin/ca.pem` (or the content of the `ca.pem` file)
+- `CLNREST_CERT`: `/home/lightningd/.lightning/bitcoin/server.pem` (or the content of the `server.pem` file)
+- `CLNREST_READONLY_RUNE`: `lightning-cli createrune restrictions='[["method=listfunds", "method=listpays", "method=listinvoices", "method=getinfo", "method=summary", "method=waitanyinvoice"]]' | jq -r .rune`
+- `CLNREST_INVOICE_RUNE`: `lightning-cli createrune restrictions='[["method=invoice"], ["pnameamount_msat<1000001"], ["pnamelabel^LNbits"], ["rate=60"]]' | jq -r .rune`
+- `CLNREST_PAY_RUNE`: `lightning-cli createrune restrictions='[["method=pay"], ["pinvbolt11_amount<1001"], ["pnamelabel^LNbits"], ["rate=1"]]' | jq -r .rune`
+- `CLNREST_RENEPAY_RUNE`: `lightning-cli createrune restrictions='[["method=renepay"], ["pinvinvstring_amount<1001"], ["pnamelabel^LNbits"], ["rate=1"]]' | jq -r .rune`
+- `CLNREST_LAST_PAY_INDEX`: `lightning-cli listinvoices | jq -r '.invoices | map(.created_index) | max' `
- `CLNREST_NODEID`: `lightning-cli getinfo | jq -r .id` (only required for v23.08)
-**Create runes (copy/paste)**
+### CoreLightning
-```bash
-# Read-only: funds, pays, invoices, info, summary, and invoice listener
-lightning-cli createrune \
- restrictions='[["method=listfunds","method=listpays","method=listinvoices","method=getinfo","method=summary","method=waitanyinvoice"]]' \
-| jq -r .rune
-```
+- `LNBITS_BACKEND_WALLET_CLASS`: **CoreLightningWallet**
+- `CORELIGHTNING_RPC`: /file/path/lightning-rpc
-```bash
-# Invoice: max 1,000,001 msat, label must start with "LNbits", 60 req/min
-lightning-cli createrune \
- restrictions='[["method=invoice"], ["pnameamount_msat<1000001"], ["pnamelabel^LNbits"], ["rate=60"]]' \
-| jq -r .rune
-```
+### CoreLightning REST
-```bash
-# Pay: bolt11 amount < 1001 (msat), label must start with "LNbits", 1 req/min
-lightning-cli createrune \
- restrictions='[["method=pay"], ["pinvbolt11_amount<1001"], ["pnamelabel^LNbits"], ["rate=1"]]' \
-| jq -r .rune
-```
+This is the old REST interface that uses [Ride The Lightning/c-lightning-REST](https://github.com/Ride-The-Lightning/c-lightning-REST)
-```bash
-# Renepay: invstring amount < 1001 (msat), label must start with "LNbits", 1 req/min
-lightning-cli createrune \
- restrictions='[["method=renepay"], ["pinvinvstring_amount<1001"], ["pnamelabel^LNbits"], ["rate=1"]]' \
-| jq -r .rune
-```
+- `LNBITS_BACKEND_WALLET_CLASS`: **CoreLightningRestWallet**
+- `CORELIGHTNING_REST_URL`: http://127.0.0.1:8185/
+- `CORELIGHTNING_REST_MACAROON`: /file/path/admin.macaroon or Base64/Hex
+- `CORELIGHTNING_REST_CERT`: /home/lightning/clnrest/tls.cert
-Set the resulting values into:
+### Spark (Core Lightning)
-- `CLNREST_READONLY_RUNE`
-- `CLNREST_INVOICE_RUNE`
-- `CLNREST_PAY_RUNE`
-- `CLNREST_RENEPAY_RUNE`
+- `LNBITS_BACKEND_WALLET_CLASS`: **SparkWallet**
+- `SPARK_URL`: http://10.147.17.230:9737/rpc
+- `SPARK_TOKEN`: secret_access_key
-## CoreLightning
+### LND (REST)
-**Required env vars**
+- `LNBITS_BACKEND_WALLET_CLASS`: **LndRestWallet**
+- `LND_REST_ENDPOINT`: http://10.147.17.230:8080/
+- `LND_REST_CERT`: /file/path/tls.cert
+- `LND_REST_MACAROON`: /file/path/admin.macaroon or Base64/Hex
-- `LNBITS_BACKEND_WALLET_CLASS`: `CoreLightningWallet`
-- `CORELIGHTNING_RPC`: `/file/path/lightning-rpc`
+or
-## CoreLightning REST
+- `LND_REST_MACAROON_ENCRYPTED`: eNcRyPtEdMaCaRoOn
-Old REST interface using [RTL c-lightning-REST](https://github.com/Ride-The-Lightning/c-lightning-REST)
+### LND (gRPC)
-**Required env vars**
+- `LNBITS_BACKEND_WALLET_CLASS`: **LndWallet**
+- `LND_GRPC_ENDPOINT`: ip_address
+- `LND_GRPC_PORT`: port
+- `LND_GRPC_CERT`: /file/path/tls.cert
+- `LND_GRPC_MACAROON`: /file/path/admin.macaroon or Base64/Hex
-- `LNBITS_BACKEND_WALLET_CLASS`: `CoreLightningRestWallet`
-- `CORELIGHTNING_REST_URL`: `http://127.0.0.1:8185/`
-- `CORELIGHTNING_REST_MACAROON`: `/file/path/admin.macaroon` or Base64/Hex
-- `CORELIGHTNING_REST_CERT`: `/home/lightning/clnrest/tls.cert`
+You can also use an AES-encrypted macaroon (more info) instead by using
-## Spark (Core Lightning)
+- `LND_GRPC_MACAROON_ENCRYPTED`: eNcRyPtEdMaCaRoOn
-**Required env vars**
+To encrypt your macaroon, run `uv run lnbits-cli encrypt macaroon`.
-- `LNBITS_BACKEND_WALLET_CLASS`: `SparkWallet`
-- `SPARK_URL`: `http://10.147.17.230:9737/rpc`
-- `SPARK_TOKEN`: `secret_access_key`
+### LNbits
-## LND (REST)
+- `LNBITS_BACKEND_WALLET_CLASS`: **LNbitsWallet**
+- `LNBITS_ENDPOINT`: e.g. https://lnbits.com
+- `LNBITS_KEY`: lnbitsAdminKey
-**Required env vars**
+### LNPay
-- `LNBITS_BACKEND_WALLET_CLASS`: `LndRestWallet`
-- `LND_REST_ENDPOINT`: `http://10.147.17.230:8080/`
-- `LND_REST_CERT`: `/file/path/tls.cert`
-- `LND_REST_MACAROON`: `/file/path/admin.macaroon` or Base64/Hex
+For the invoice listener to work you have a publicly accessible URL in your LNbits and must set up [LNPay webhooks](https://dashboard.lnpay.co/webhook/) pointing to `Refresh Interval and History Size are for
+ historical purposes only.
+ API URL and JSON Path fields can use the
+ {to} and {TO} placeholders for the code of the
+ currency
+ {TO} is the uppercase code and {to} is the
+ lowercase code
+ checkout.session.async_payment_failedcheckout.session.async_payment_succeededcheckout.session.completedcheckout.session.expired- -
-- -
+ {% if LNBITS_NODE_UI_AVAILABLE %} ++
+ {% endif %}
- -
+
-
-
-
- -
+
- -
+
- -
+
- -
+
@@ -151,9 +131,7 @@
- -
+
- -
+
- -
+
-
GET /api/v1/wallet
+ {"X-Api-Key": ""}{"id": <string>, "name": <string>, "balance":
+ <int>}
+ curl api/v1/wallet -H "X-Api-Key:
+ "
+ POST /api/v1/payments
+ {"X-Api-Key": ""}{"out": false, "amount": <int>, "memo": <string>,
+ "expiry": <int>, "unit": <string>, "webhook":
+ <url:string>, "internal": <bool>}
+ {"payment_hash": <string>, "payment_request":
+ <string>}
+ curl -X POST api/v1/payments -d
+ '{"out": false, "amount": <int>, "memo": <string>}' -H
+ "X-Api-Key:
+ " -H
+ "Content-type: application/json"
+ POST /api/v1/payments (reveal
+ admin keys
+
+ {"X-Api-Key": ""}
+ {"out": true, "bolt11": <string>}
+ {"payment_hash": <string>}
+ curl -X POST api/v1/payments -d
+ '{"out": true, "bolt11": <string>}' -H "X-Api-Key:
+ " -H "Content-type: application/json"
+ POST
+ /api/v1/payments/decode
+ {"data": <string>}
+ curl -X POST api/v1/payments/decode -d
+ '{"data": <bolt11/lnurl, string>}' -H "Content-type:
+ application/json"
+ GET
+ /api/v1/payments/<payment_hash>
+ {"X-Api-Key": ""}
+ {"paid": <bool>}
+ curl -X GET
+ api/v1/payments/<payment_hash> -H
+ "X-Api-Key:
+ " -H
+ "Content-type: application/json"
+ WS
+ /api/v1/ws/<invoice_key>
+
+ wscat -c /
+ {"balance": <int>, "payment": <object>}
+ Authorization
+
+
+ header.
+ | + Header Name + | ++ Header Value + | +
|---|---|
| + Authorization + | +
+
+
+
+ Bearer
+
+
+
+ |
+
+
+
+
+ +
+
+
+
`name` and
+ `sort description` fields are what the users will
+ see when browsing the list of extensions.
+ `id` field is used internally and in the URL of
+ your extension.
+ created_at, updated_at and
+ extra.
+ Wallet will be
+ shown.
+ Currency will
+ be shown.
+ Integer and
+ Float will be shown.
+ Boolean will be
+ shown.
+ + +
+ {{SITE_DESCRIPTION}} +
+ + ++ is requesting an invoice: +
+ {% if LNBITS_DENOMINATION != 'sats' %} ++ Authenticate with ? +
++ For every website and for every LNbits wallet, a new keypair + will be deterministically generated so your identity can't be + tied to your LNbits wallet or linked across websites. No other + data will be shared with + . +
++ Your public key for is: +
+
+
+
+ is requesting
+
+
+
+
+ and a
+ -char
+ comment
+
+
+
+ is requesting
+ between
+ and
+
+
+
+
+ and a
+ -char
+ comment
+
+
+