From e30a056081938b587f5a20161b1179ed5951f976 Mon Sep 17 00:00:00 2001 From: ffranr Date: Wed, 26 Nov 2025 16:17:36 +0000 Subject: [PATCH 1/4] readme: align table columns --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 854dc3851..e83b0aabc 100644 --- a/README.md +++ b/README.md @@ -154,15 +154,15 @@ The following table shows the supported combinations: | `faraday-mode=integrated` | X | X | | `loop-mode=integrated` | X | X | | `pool-mode=integrated` | X | X | -| `taproot-assets-mode=integrated` | X | X | +| `taproot-assets-mode=integrated` | X | X | | `faraday-mode=remote` | | X | | `loop-mode=remote` | | X | | `pool-mode=remote` | | X | -| `taproot-assets-mode=remote` | | X | +| `taproot-assets-mode=remote` | | X | | `faraday-mode=disable` | X | X | | `loop-mode=disable` | X | X | | `pool-mode=disable` | X | X | -| `taproot-assets-mode=disable` | X | X | +| `taproot-assets-mode=disable` | X | X | | `lnd` running in "stateless init" mode | X | | NOTE: Taproot Assets **Channel** functionality is only available when both `lnd` From c9d1915be13bc0fe45d93be441895477acbdacfc Mon Sep 17 00:00:00 2001 From: ffranr Date: Wed, 26 Nov 2025 16:20:22 +0000 Subject: [PATCH 2/4] readme: remove daemon versions table This information is now available in the GitHub release notes for each release. Removing it from the README simplifies the project release procedure (no need to update) and avoids unnecessary duplication, reducing the risk of inconsistencies. --- README.md | 64 ------------------------------------------------------- 1 file changed, 64 deletions(-) diff --git a/README.md b/README.md index e83b0aabc..cc1da4927 100644 --- a/README.md +++ b/README.md @@ -169,67 +169,3 @@ NOTE: Taproot Assets **Channel** functionality is only available when both `lnd` and `tapd` are running in the same process (by setting both `lnd-mode=integrated` and `taproot-assets-mode=integrated`). Remote mode support will be added in the future. - -## Daemon Versions packaged with LiT - -| LiT | LND | Loop | Faraday | Pool | Taproot Assets | -|-------------------|--------------|--------------|---------------|--------------|----------------| -| **v0.16.0-alpha** | v0.20.0-beta | v0.31.6-beta | v0.2.16-alpha | v0.6.6-beta | v0.7.0-alpha | -| **v0.15.3-alpha** | v0.19.3-beta | v0.31.5-beta | v0.2.16-alpha | v0.6.6-beta | v0.6.1-alpha | -| **v0.15.2-alpha** | v0.19.3-beta | v0.31.2-beta | v0.2.16-alpha | v0.6.6-beta | v0.6.1-alpha | -| **v0.15.1-alpha** | v0.19.2-beta | v0.31.2-beta | v0.2.16-alpha | v0.6.6-beta | v0.6.1-alpha | -| **v0.15.0-alpha** | v0.19.1-beta | v0.31.2-beta | v0.2.16-alpha | v0.6.6-beta | v0.6.0-alpha | -| **v0.14.1-alpha** | v0.18.5-beta | v0.29.0-beta | v0.2.14-alpha | v0.6.5-beta | v0.5.1-alpha | -| **v0.14.0-alpha** | v0.18.4-beta | v0.29.0-beta | v0.2.13-alpha | v0.6.5-beta | v0.5.0-alpha | -| **v0.13.6-alpha** | v0.18.3-beta | v0.28.8-beta | v0.2.13-alpha | v0.6.5-beta | v0.4.1-alpha | -| **v0.13.5-alpha** | v0.18.3-beta | v0.28.8-beta | v0.2.13-alpha | v0.6.5-beta | v0.4.1-alpha | -| **v0.13.4-alpha** | v0.18.3-beta | v0.28.7-beta | v0.2.13-alpha | v0.6.5-beta | v0.4.1-alpha | -| **v0.13.3-alpha** | v0.18.2-beta | v0.28.6-beta | v0.2.13-alpha | v0.6.5-beta | v0.4.1-alpha | -| **v0.13.2-alpha** | v0.18.2-beta | v0.28.5-beta | v0.2.13-alpha | v0.6.5-beta | v0.3.3-alpha | -| **v0.13.1-alpha** | v0.18.1-beta | v0.28.5-beta | v0.2.13-alpha | v0.6.5-beta | v0.3.3-alpha | -| **v0.13.0-alpha** | v0.18.0-beta | v0.28.5-beta | v0.2.13-alpha | v0.6.5-beta | v0.3.3-alpha | -| **v0.12.5-alpha** | v0.17.5-beta | v0.28.1-beta | v0.2.13-alpha | v0.6.4-beta | v0.3.3-alpha | -| **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 | From d342745105803a85792cf4bb0a27cea1e4767e05 Mon Sep 17 00:00:00 2001 From: ffranr Date: Wed, 26 Nov 2025 16:29:03 +0000 Subject: [PATCH 3/4] docs: archive compatibility table and trim README guidance Move the LiT/LND compatibility matrix into docs/compatibility.md for archival so future releases no longer require README updates to adjust the table. Update README to direct users to release notes for minimum lnd versions and fall back to the archived table when not specified. --- README.md | 111 ++++++++++-------------------------------- docs/compatibility.md | 71 +++++++++++++++++++++++++++ 2 files changed, 98 insertions(+), 84 deletions(-) create mode 100644 docs/compatibility.md diff --git a/README.md b/README.md index cc1da4927..1b0a56e81 100644 --- a/README.md +++ b/README.md @@ -64,90 +64,33 @@ If you encounter any issues please see our [troubleshooting guide](./docs/troubl ## Build from source If you’d prefer to compile from source code please follow [these instructions](./docs/compile.md). -## Compatibility - -Full Lightning Terminal functionality can be dependent on running a compatible -version of `lnd`. View the table below to ensure that you run a compatible -version of `lnd` with the relevant `litd` release. - -This version compatibility dependency table is only relevant when running litd -in remote mode (meaning that `lnd-mode=remote` is set). It shows the -**_minimum_** `lnd` version that can be used with different versions of `litd` -(LiT). The bundled version will always come with the correct, -[compatible versioning](#daemon-versions-packaged-with-lit). - -| LiT | LND | -|-------------------|--------------| -| **v0.16.0-alpha** | v0.19.0-beta | -| **v0.15.3-alpha** | v0.19.0-beta | -| **v0.15.2-alpha** | v0.19.0-beta | -| **v0.15.1-alpha** | v0.19.0-beta | -| **v0.15.0-alpha** | v0.19.0-beta | -| **v0.14.1-alpha** | v0.18.5-beta | -| **v0.14.0-alpha** | v0.18.4-beta | -| **v0.13.6-alpha** | v0.17.1-beta | -| **v0.13.5-alpha** | v0.17.1-beta | -| **v0.13.4-alpha** | v0.17.1-beta | -| **v0.13.3-alpha** | v0.17.1-beta | -| **v0.13.2-alpha** | v0.17.0-beta | -| **v0.13.1-alpha** | v0.17.0-beta | -| **v0.13.0-alpha** | v0.17.0-beta | -| **v0.12.5-alpha** | v0.17.0-beta | -| **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)](docs/config-lnd-integrated.md) 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)](docs/config-lnd-remote.md). - -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: +## Component Compatibility + +This section describes version and mode compatibility across Lightning Terminal +(LiT) and its component daemons. + +### LND Version Compatibility + +LiT can operate in two modes: [integrated](docs/config-lnd-integrated.md) and +[remote](docs/config-lnd-remote.md). Version compatibility between LiT and `lnd` +matters only when running in remote mode. The lnd version bundled in +integrated mode is always compatible. + +Each LiT release should specify the minimum compatible `lnd` version in its +[GitHub release +notes](https://github.com/lightninglabs/lightning-terminal/releases). If a +release does not document compatibility, the required information is available +in the archived compatibility table in +[docs/compatibility.md](./docs/compatibility.md). + +### Compatibility With Additional Daemons + +LiT also bundles several additional daemons: Faraday, Loop, Pool and Taproot +Assets. Each can be configured as integrated, remote or disabled. This creates +many possible configurations, and not all combinations are supported due to +technical constraints. + +The following table lists supported combinations: | | `lnd-mode=integrated` | `lnd-mode=remote` | |----------------------------------------|-----------------------|-------------------| diff --git a/docs/compatibility.md b/docs/compatibility.md new file mode 100644 index 000000000..57b3dd11d --- /dev/null +++ b/docs/compatibility.md @@ -0,0 +1,71 @@ +# LND Version Compatibility With ***Remote Mode*** LiT + +Full Lightning Terminal functionality can be dependent on running a compatible +version of `lnd`. For new releases, the minimum required `lnd` version should be +specified in the GitHub release notes. If a release note does not mention it +(for example, older releases), refer to the archived compatibility table below. + +This version compatibility dependency table is only relevant when running LiT in +remote mode (meaning that `lnd-mode=remote` is set). It shows the **minimum** +`lnd` version that can be used with different versions of `litd` (LiT). The +bundled version will always come with the correct compatible versioning. + +| LiT | min LND version | +|-------------------|-----------------| +| **v0.16.0-alpha** | v0.19.0-beta | +| **v0.15.3-alpha** | v0.19.0-beta | +| **v0.15.2-alpha** | v0.19.0-beta | +| **v0.15.1-alpha** | v0.19.0-beta | +| **v0.15.0-alpha** | v0.19.0-beta | +| **v0.14.1-alpha** | v0.18.5-beta | +| **v0.14.0-alpha** | v0.18.4-beta | +| **v0.13.6-alpha** | v0.17.1-beta | +| **v0.13.5-alpha** | v0.17.1-beta | +| **v0.13.4-alpha** | v0.17.1-beta | +| **v0.13.3-alpha** | v0.17.1-beta | +| **v0.13.2-alpha** | v0.17.0-beta | +| **v0.13.1-alpha** | v0.17.0-beta | +| **v0.13.0-alpha** | v0.17.0-beta | +| **v0.12.5-alpha** | v0.17.0-beta | +| **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 | From 62bf127421f9046e768d6dd2f2ff7357f66b4ba8 Mon Sep 17 00:00:00 2001 From: ffranr Date: Wed, 26 Nov 2025 16:38:45 +0000 Subject: [PATCH 4/4] readme: format lines for soft max length of 80 columns Reformatted multiple lines in the README to follow the soft maximum line length of 80 columns, improving readability. --- README.md | 72 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 56 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 1b0a56e81..ee17a8299 100644 --- a/README.md +++ b/README.md @@ -2,26 +2,34 @@ ![CI](https://github.com/lightninglabs/lightning-terminal/workflows/CI/badge.svg) -Lightning Terminal (LiT) is a browser-based interface for managing channel liquidity. +Lightning Terminal (LiT) is a browser-based interface for managing channel +liquidity. ![screenshot](./app/src/assets/images/screenshot.png) ## Features + - Visualize your channels and balances -- Perform submarine swaps via the [Lightning Loop](https://lightning.engineering/loop) service +- Perform submarine swaps via + the [Lightning Loop](https://lightning.engineering/loop) service - Classify channels according to your node's operating mode -- Run a single binary that integrates [`loopd`](https://github.com/lightninglabs/loop), +- Run a single binary that integrates + [`loopd`](https://github.com/lightninglabs/loop), [`poold`](https://github.com/lightninglabs/pool) and [`faraday`](https://github.com/lightninglabs/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](https://github.com/lightninglabs/lightning-terminal/releases) page. -Additionally, you can find detailed instructions on the [docs.lightning.engineering](https://docs.lightning.engineering/lightning-network-tools/lightning-terminal/get-lit) page. +Download the latest binaries from the [releases](https://github.com/lightninglabs/lightning-terminal/releases) +page. + +Additionally, you can find detailed instructions on the [docs.lightning.engineering](https://docs.lightning.engineering/lightning-network-tools/lightning-terminal/get-lit) +page. ## Execution + Run Lightning Terminal with a local `lnd` instance: ```shell @@ -30,39 +38,71 @@ Run Lightning Terminal with a local `lnd` instance: 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. +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](./docs/config-lnd-remote.md). If you would like to replace your existing LND instance with the one integrated within LiT please see [configuring Terminal](./docs/config-lnd-integrated.md). +To use LiT with a remote `lnd` instance +please [follow these instructions](./docs/config-lnd-remote.md). If you would +like to replace your existing LND instance with the one integrated within LiT +please see [configuring Terminal](./docs/config-lnd-integrated.md). ## 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](https://github.com/lightningnetwork/lnd/releases/latest) or build `lnd` from source by following the [installation instructions](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md). If you choose to build `lnd` from source, use the following command to enable all the relevant subservers: + +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](https://github.com/lightningnetwork/lnd/releases/latest) +or build `lnd` from source by following +the [installation instructions](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md). +If you choose to build `lnd` from source, use the following command to enable +all the relevant subservers: ```shell ⛰ 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](https://letsencrypt.org/). View the -[Let's Encrypt Configuration](./docs/letsencrypt.md) doc for instructions on how to configure this. + +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](https://letsencrypt.org/). View the +[Let's Encrypt Configuration](./docs/letsencrypt.md) 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: +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`). +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](docs/WALKTHROUGH.md) document to learn more about how to use LiT. + +Read the [walkthrough](docs/WALKTHROUGH.md) document to learn more about how to +use LiT. ## Troubleshooting -If you encounter any issues please see our [troubleshooting guide](./docs/troubleshooting.md). + +If you encounter any issues please see +our [troubleshooting guide](./docs/troubleshooting.md). ## Build from source -If you’d prefer to compile from source code please follow [these instructions](./docs/compile.md). + +If you’d prefer to compile from source code please +follow [these instructions](./docs/compile.md). ## Component Compatibility