Builder's Guide
Ask or search…
K
🛠️

Get litd

Learn how to run litd in integrated mode, install litd alongside your existing LND installation, or move an existing system to litd.
Litd gives your node access to features such as LND Accounts or LNC while bundling LND with Loop, Pool, Faraday, and, in the future, Taproot Assets.
You can point litd at your existing LND, Loop or Pool installation, or you can run LND as part of litd. Running the entire bundle as a single binary is most reliable and convenient. Plus,individual components can be easily swapped out at will, for example to apply patches or run pre-release software.

Install litd

You can install litd from source or via the provided binary. If you are running LND as part of a software bundle like Umbrel, litd might already be installed on your node.

Install the binary

Choose this option for a quick and convenient installation. You can find the binaries and verification instructions for the latest release on Github.
Once you have downloaded the binary for your operating system, verify them and unpack them, either with your file manager or the command line. This may look like this:
tar -xvf lightning-terminal--alpha.tar.gz
Or on Windows:
tar -xvzf C:\path\lightning-temrinal-alpha.tar.gz -C C:\path\litd
You can now execute the program from its location, or place it where the system can conveniently find it, such as /bin/litd on Linux.

Install from source

Prerequisites

  1. 1.
    You will need Go version 1.19 or higher. If you compiled LND from source this should already be installed on your system. You can find detailed instructions here.
  2. 2.
    You will need nodejs. You can download and install it here. Most conveniently, you can install it with snap install node
  3. 3.
    You will need yarn. You can download it here. Most conveniently, you can install it with npm install --global yarn

Install litd

  1. 1.
    First we will download the source code from Github git clone https://github.com/lightninglabs/lightning-terminal.git cd lightning-terminal git checkout <latest version>
  2. 2.
    We install litd with: make install
  3. 3.
    If you do not already have LND, Loop or Pool installed, you may run LND in integrated mode, meaning one binary bundle. In this case, you will have to also install the CLI interfaces make go-install-cli You can alternavitely install both the bundle and the CLI interfaces with one command. make install make go-install-cli

Install in BTCPay Server

BTCPay contains an installation script for litd, which makes it easy to include litd into your BTCPay Server. You may also refer to the official guide.
  1. 1.
    Set a password for your litd instance: export LIT_PASSWD="YOUR PASSWORD HERE"
  2. 2.
    Add the fragment to your configuration and run the installation script: BTCPAYGEN_ADDITIONAL_FRAGMENTS="$BTCPAYGEN_ADDITIONAL_FRAGMENTS;opt-add-lightning-terminal" . btcpay-setup.sh -i
  3. 3.
    You can now find litd under Server Settings > Services