GlcoinCore/lightning-terminal
1
0
Fork 0
mirror of https://github.com/lightninglabs/lightning-terminal.git synced 2026-08-13 12:33:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2
No description
1398 commits 47 branches 113 tags 41 MiB
Find a file
Exact
bitromortac 5129b95fd5
rules+rpcserver: handle unknown rules 
This is to tolerate unknown rules sent from the autopilot for the
`autopilot features` command.

Otherwise, when trying to register a feature that requires an upgrade, a
more user friendly error is returned.
2024-04-25 18:19:48 +02:00
.github GitHub: re-enable the linter 2024-01-03 11:14:51 +01:00
.vscode chore: fix vscode linting with wrong TS version 2021-01-27 11:11:24 -05:00
accounts accounts + main: allow new accounts with 0 balance 2024-02-01 11:22:08 +02:00
app litrpc: add privacy flags 2024-04-25 14:49:46 +02:00
autopilotserver itest: add tests for privacy flags 2024-04-25 14:49:47 +02:00
autopilotserverrpc litrpc: add privacy flags 2024-04-25 14:49:46 +02:00
cmd litcli: add privacy flags to feature registration 2024-04-25 14:49:47 +02:00
doc doc: add note for remote lnd credentials 2023-04-26 11:00:47 +03:00
firewall firewall: intercept with privacy flags 2024-04-25 14:49:46 +02:00
firewalldb firewall+firewalldb: add SessionDB interface 2024-04-25 14:49:45 +02:00
itest itest: add tests for privacy flags 2024-04-25 14:49:47 +02:00
litclient multi: init status manager 2023-09-22 11:59:24 +02:00
litrpc litrpc: add privacy flags 2024-04-25 14:49:46 +02:00
make make: remove release targets incompatible with sqlc 2023-05-16 17:00:20 +02:00
perms multi: init status manager 2023-09-22 11:59:24 +02:00
proto litrpc: add privacy flags 2024-04-25 14:49:46 +02:00
queue terminal+queue: add concurrent error queue 2022-10-15 09:05:04 +02:00
rpcmiddleware rpcmiddleware+accounts: add checkers 2022-12-02 10:06:50 +01:00
rules rules+rpcserver: handle unknown rules 2024-04-25 18:19:48 +02:00
scripts multi: update lnd dependency to v0.16.0-beta.rc3 2023-03-15 08:36:23 -07:00
session session: add privacy flags to session tlvs 2024-04-25 14:49:45 +02:00
status status: apply functional options on subServer init 2024-01-15 20:13:31 +01:00
subservers multi: bump taproot-assets, loop & LNC 2023-10-18 18:45:17 +02:00
tools tools: update linter to latest version 2024-04-25 14:49:36 +02:00
.dockerignore cmd: rename binary to litd 2020-07-21 22:10:33 +02:00
.gitattributes chore: fix generated code being included in language stats 2020-12-11 18:00:16 -05:00
.gitignore itest+make: add remote mode integration test 2022-02-08 15:33:19 +01:00
.golangci.yml tools: update linter to latest version 2024-04-25 14:49:36 +02:00
.prettierrc docs: reformat readme markdown 2020-06-13 00:39:59 -04:00
config.go config: allow taproot-assets-mode to be remote 2023-10-19 13:32:32 -05:00
deps.go multi: dockerize tools 2022-10-19 10:57:18 +02:00
dev.Dockerfile multi: update to go 1.21 2023-11-03 13:39:34 -05:00
Dockerfile multi: update to go 1.21 2023-11-03 13:39:34 -05:00
go.mod build(deps): bump github.com/docker/docker 2024-03-20 17:25:28 +00:00
go.sum build(deps): bump github.com/docker/docker 2024-03-20 17:25:28 +00:00
gzip.go multi: rename golang and make files to lightning-terminal 2020-07-21 22:06:15 +02:00
LICENSE docs: add MIT license 2021-07-16 18:27:27 -04:00
lnd_connection.go multi: split out LND connection from rpcProxy 2023-05-01 00:15:56 -07:00
log.go terminal: add gbn subsystem to logger 2024-02-08 19:37:40 +01:00
Makefile tools: update linter to latest version 2024-04-25 14:49:36 +02:00
README.md build: bump version to v0.12.4-alpha 2024-03-08 19:52:22 +01:00
release.sh release+make: also build tapcli 2023-05-16 17:00:55 +02:00
rpc_proxy.go multi: use request overrides in RPC proxy 2024-01-05 03:46:54 +01:00
session_rpcserver.go rules+rpcserver: handle unknown rules 2024-04-25 18:19:48 +02:00
terminal.go terminal: update minimum lnd version to v0.17.0` 2024-03-08 11:09:02 +01:00
version.go build: bump version to v0.12.4-alpha 2024-03-08 19:52:22 +01:00

README.md

Lightning Terminal (LiT)

CI

Lightning Terminal (LiT) is a browser-based interface for managing channel liquidity.

screenshot

Features

  • Visualize your channels and balances
  • Perform submarine swaps via the Lightning Loop service
  • Classify channels according to your node's operating mode
  • Run a single binary that integrates loopd, poold and faraday daemons all in one
  • Access a preview release of the Pool UI
  • Use Pool to earn sats by opening channels to those needing inbound liquidity

Installation

Download the latest binaries from the releases page.

Additionally, you can find detailed instructions on the docs.lightning.engineering page.

Execution

Run Lightning Terminal with a local lnd instance:

⛰  ./litd --uipassword=UP48lm4Vjqxy<change_this_or_you_will_get_robbed>

Visit https://localhost:8443 to access Terminal.

Note that a password with a minimum of 8 characters is required to run Lightning Terminal. In a production environment, it's recommended that you store this password as an environment variable to avoid it being recorded in the command history.

To use LiT with a remote lnd instance please follow these instructions. If you would like to replace your existing LND instance with the one integrated within LiT please see configuring Terminal.

LND

Note that LiT requires lnd to be built with all of its subservers and requires running at least v0.11.0. Download the latest official release binary or build lnd from source by following the installation instructions. If you choose to build lnd from source, use the following command to enable all the relevant subservers:

⛰  make install tags="signrpc walletrpc chainrpc invoicesrpc"

Interaction

If you plan to run LiT on a remote machine but access the web-interface from your computer you may not want to deal with self-signed certificate browser warnings. To avoid these warnings configure the HTTP server to use a certificate from Let's Encrypt. View the Let's Encrypt Configuration doc for instructions on how to configure this.

Upgrading

If you used command line arguments with previous versions then you don't need to change anything when upgrading.

To upgrade from v0.1.1-alpha or earlier simply create a lit.conf file in your LiT directory. The default location LiT uses depends on your operating system:

  • MacOS: ~/Library/Application Support/Lit/lit.conf
  • Linux: ~/.lit/lit.conf
  • Windows: ~/AppData/Roaming/Lit/lit.conf

Move all the configuration settings specific to LiT from lnd.conf to lit.conf and remove any previous LiT-specific customizations from the configuration settings in lnd.conf. Note that any section headers ([ Example ]) in lit.conf should be removed or changed to comments (# Example).

Usage

Read the walkthrough document to learn more about how to use LiT.

Troubleshooting

If you encounter any issues please see our troubleshooting guide.

Build from source

If you’d prefer to compile from source code please follow these instructions.

Compatibility

Full Lightning Terminal functionality can be dependent on running a certain version of lnd. View the table below to ensure that you run the correct version of lnd with the relevant litd release.

This version compatibility dependency is only relevant for running remote mode litd. The bundled version will always come with the correct, compatible versioning.

LiT LND
v0.12.4-alpha v0.17.0-beta
v0.12.3-alpha v0.16.0-beta
v0.12.2-alpha v0.16.0-beta
v0.12.1-alpha v0.16.0-beta
v0.12.0-alpha v0.16.0-beta
v0.11.0-alpha v0.16.0-beta
v0.10.5-alpha v0.16.0-beta
v0.10.4-alpha v0.16.0-beta
v0.10.2-alpha v0.16.0-beta
v0.10.1-alpha v0.16.0-beta
v0.10.0-alpha v0.16.0-beta
v0.9.2-alpha v0.16.0-beta
v0.9.1-alpha v0.16.0-beta
v0.9.0-alpha v0.16.0-beta
v0.8.6-alpha v0.15.4-beta
v0.8.5-alpha v0.15.4-beta
v0.8.4-alpha v0.15.1-beta
v0.8.3-alpha v0.15.1-beta
v0.8.2-alpha v0.15.1-beta
v0.8.1-alpha v0.15.1-beta
v0.8.0-alpha v0.15.1-beta
v0.7.1-alpha v0.14.3-beta
v0.7.0-alpha v0.14.3-beta
v0.6.7-alpha v0.13.3-beta
v0.6.6-alpha v0.13.3-beta
v0.6.5-alpha v0.13.3-beta
v0.6.4-alpha v0.13.3-beta
v0.6.3-alpha v0.13.3-beta
v0.6.2-alpha v0.13.3-beta
v0.6.1-alpha v0.13.3-beta
v0.6.0-alpha v0.13.3-beta
v0.5.2-alpha v0.12.0-beta
v0.5.1-alpha v0.12.0-beta
v0.5.0-alpha v0.12.0-beta
v0.4.1-alpha v0.11.1-beta
v0.4.0-alpha v0.11.1-beta
v0.3.4-alpha v0.11.1-beta
v0.3.3-alpha v0.11.1-beta
v0.3.2-alpha v0.11.1-beta
v0.3.1-alpha v0.11.1-beta
v0.3.0-alpha v0.11.1-beta
v0.2.0-alpha v0.11.0-beta

LiT offers two main operating modes, one in which lnd is running inside the LiT process (called "lnd integrated mode", set by lnd-mode=integrated config option) and one in which lnd is running in a standalone process on the same or remote machine (called "lnd remote mode", set by lnd-mode=remote config option).

In addition to those main modes, the individual bundled daemons (Faraday, Loop and Pool) can be toggled to be integrated or remote as well, or as disabled. This offers a large number of possible configuration combinations, of which not all are fully supported due to technical reasons.

The following table shows the supported combinations:

lnd-mode=integrated lnd-mode=remote
faraday-mode=integrated X X
loop-mode=integrated X X
pool-mode=integrated X X
taprootassets-mode=integrated X X
faraday-mode=remote X
loop-mode=remote X
pool-mode=remote X
taprootassets-mode=remote X
faraday-mode=disable X X
loop-mode=disable X X
pool-mode=disable X X
taprootassets-mode=disable X X
lnd running in "stateless init" mode X

Daemon Versions packaged with LiT

LiT LND Loop Faraday Pool Taproot Assets
v0.12.4-alpha v0.17.4-beta v0.28.0-beta v0.2.13-alpha v0.6.4-beta v0.3.3-alpha
v0.12.3-alpha v0.17.4-beta v0.27.0-beta v0.2.11-alpha v0.6.4-beta v0.3.3-alpha
v0.12.2-alpha v0.17.3-beta v0.26.6-beta v0.2.11-alpha v0.6.4-beta v0.3.2-alpha
v0.12.1-alpha v0.17.1-beta v0.26.5-beta v0.2.11-alpha v0.6.4-beta v0.3.1-alpha
v0.12.0-alpha v0.17.0-beta v0.26.4-beta v0.2.11-alpha v0.6.4-beta v0.3.0-alpha
v0.11.0-alpha v0.17.0-beta v0.26.3-beta v0.2.11-alpha v0.6.4-beta v0.2.3-alpha
v0.10.5-alpha v0.16.4-beta v0.26.2-beta v0.2.11-alpha v0.6.4-beta v0.2.3-alpha
v0.10.4-alpha v0.16.4-beta v0.25.2-beta v0.2.11-alpha v0.6.4-beta v0.2.3-alpha
v0.10.2-alpha v0.16.4-beta v0.25.2-beta v0.2.11-alpha v0.6.4-beta v0.2.2-alpha
v0.10.1-alpha v0.16.3-beta v0.24.1-beta v0.2.11-alpha v0.6.4-beta v0.2.0-alpha
v0.10.0-alpha v0.16.2-beta v0.23.0-beta v0.2.11-alpha v0.6.2-beta v0.2.0-alpha
v0.9.2-alpha v0.16.2-beta v0.23.0-beta v0.2.11-alpha v0.6.2-beta n/a
v0.9.1-alpha v0.16.1-beta v0.23.0-beta v0.2.11-alpha v0.6.2-beta n/a
v0.9.0-alpha v0.16.0-beta v0.22.0-beta v0.2.10-alpha v0.6.2-beta n/a
v0.8.6-alpha v0.15.5-beta v0.21.0-beta v0.2.9-alpha v0.6.1-beta n/a
v0.8.5-alpha v0.15.5-beta v0.20.2-beta v0.2.9-alpha v0.6.1-beta n/a
v0.8.4-alpha v0.15.5-beta v0.20.1-beta v0.2.9-alpha v0.5.8-alpha n/a
v0.8.3-alpha v0.15.4-beta v0.20.1-beta v0.2.8-alpha v0.5.8-alpha n/a
v0.8.2-alpha v0.15.3-beta v0.20.1-beta v0.2.8-alpha v0.5.8-alpha n/a
v0.8.1-alpha v0.15.2-beta v0.20.1-beta v0.2.8-alpha v0.5.8-alpha n/a
v0.8.0-alpha v0.15.1-beta v0.20.1-beta v0.2.8-alpha v0.5.8-alpha n/a
v0.7.1-alpha v0.15.0-beta v0.19.1-beta v0.2.8-alpha v0.5.7-alpha n/a
v0.7.0-alpha v0.15.0-beta v0.19.1-beta v0.2.8-alpha v0.5.7-alpha n/a
v0.6.7-alpha v0.14.3-beta v0.18.0-beta v0.2.7-alpha v0.5.6-alpha n/a
v0.6.6-alpha v0.14.3-beta v0.18.0-beta v0.2.7-alpha v0.5.6-alpha n/a
v0.6.5-alpha v0.14.2-beta v0.15.1-beta v0.2.7-alpha v0.5.5-alpha n/a
v0.6.4-alpha v0.14.2-beta v0.15.1-beta v0.2.7-alpha v0.5.4-alpha n/a
v0.6.3-alpha v0.14.2-beta v0.15.1-beta v0.2.7-alpha v0.5.4-alpha n/a
v0.6.2-alpha v0.14.1-beta v0.15.1-beta v0.2.7-alpha v0.5.4-alpha n/a
v0.6.1-alpha v0.14.1-beta v0.15.1-beta v0.2.7-alpha v0.5.2-alpha n/a
v0.5.3-alpha v0.13.3-beta v0.14.1-beta v0.2.6-alpha v0.5.0-alpha n/a
v0.5.2-alpha v0.13.3-beta v0.14.1-beta v0.2.6-alpha v0.5.0-alpha n/a
v0.5.1-alpha v0.13.0-beta v0.14.1-beta v0.2.6-alpha v0.5.0-alpha n/a
v0.5.0-alpha v0.13.0-beta v0.14.1-beta v0.2.6-alpha v0.5.0-alpha n/a
v0.4.1-alpha v0.12.1-beta v0.11.4-beta v0.2.3-alpha v0.4.4-alpha n/a
v0.4.0-alpha v0.12.0-beta v0.11.2-beta v0.2.3-alpha v0.4.3-alpha n/a
v0.3.4-alpha v0.11.1-beta v0.11.2-beta v0.2.2-alpha v0.3.4-alpha n/a
v0.3.3-alpha v0.11.1-beta v0.11.2-beta v0.2.2-alpha v0.3.4-alpha n/a
v0.3.2-alpha v0.11.1-beta v0.11.1-beta v0.2.2-alpha v0.3.4-alpha n/a
v0.3.1-alpha v0.11.1-beta v0.11.1-beta v0.2.2-alpha v0.3.3-alpha n/a
v0.3.0-alpha v0.11.1-beta v0.11.0-beta v0.2.2-alpha v0.3.2-alpha n/a
v0.2.0-alpha v0.11.1-beta v0.10.0-beta v0.2.1-alpha n/a n/a
v0.1.1-alpha v0.11.0-beta v0.8.1-beta v0.2.0-alpha n/a n/a
v0.1.0-alpha v0.10.3-beta v0.6.5-beta v0.2.0-alpha n/a n/a