mirror of
https://github.com/lightninglabs/lightning-terminal.git
synced 2026-08-13 12:33:36 +02:00
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.
This commit is contained in:
ffranr
parent
c9d1915be1
commit
d342745105
2 changed files with 92 additions and 78 deletions
99
README.md
99
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
|
||||
## Component 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 section describes version and mode compatibility across Lightning Terminal
|
||||
(LiT) and its component daemons.
|
||||
|
||||
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).
|
||||
### LND Version Compatibility
|
||||
|
||||
| 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 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.
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
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.
|
||||
### Compatibility With Additional Daemons
|
||||
|
||||
The following table shows the supported combinations:
|
||||
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` |
|
||||
|----------------------------------------|-----------------------|-------------------|
|
||||
|
|
|
|||
71
docs/compatibility.md
Normal file
71
docs/compatibility.md
Normal file
|
|
@ -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 |
|
||||
Loading…
Add table
Add a link
Reference in a new issue