nix-bitcoin lnbits extension

This repo contains an extension for the nix-bitcoin project, adding support for hosting an lnbits instance with support for several backend wallets.

Status

This repository is a work in progress, for current todo list see, TODO.md

Currently supports the following backends:

• clightning
• lnd
• lndrest

Installation

At the moment, installation is only supported via flakes. See nix-bitcoin documentation for information on setting up a flake-based node with nix-bitcoin.

To add the nix-bitcoin-lnbits extension:

1. Add the following input into your flake.nix:

nix-bitcoin-lnbits = {
    url = "github:wskeele/nix-bitcoin-lnbits";
    inputs.nix-bitcoin.follows = "nix-bitcoin";
};

2. Include the default modules into the system configuration:

nix-bitcoin-lnbits.nixosModules.default

3. Enable lnbits in configuration.nix.

Example configuration:

  services.lnbits = {
    enable = true;
    backend = "CoreLightningWallet";
    adminUI.enable = true;
    nodeUI.enable = true;
    nodeUI.enableTransactions = true;
    tor.proxy = true;
    tor.enforce = true;
  };