Skip to content

Commit d342745

Browse files
ffranrffranr
committed
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.
1 parent c9d1915 commit d342745

File tree

2 files changed

+98
-84
lines changed

2 files changed

+98
-84
lines changed

‎README.md‎

Lines changed: 27 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -64,90 +64,33 @@ If you encounter any issues please see our [troubleshooting guide](./docs/troubl
6464
## Build from source
6565
If you’d prefer to compile from source code please follow [these instructions](./docs/compile.md).
6666

67-
## Compatibility
68-
69-
Full Lightning Terminal functionality can be dependent on running a compatible
70-
version of `lnd`. View the table below to ensure that you run a compatible
71-
version of `lnd` with the relevant `litd` release.
72-
73-
This version compatibility dependency table is only relevant when running litd
74-
in remote mode (meaning that `lnd-mode=remote` is set). It shows the
75-
**_minimum_** `lnd` version that can be used with different versions of `litd`
76-
(LiT). The bundled version will always come with the correct,
77-
[compatible versioning](#daemon-versions-packaged-with-lit).
78-
79-
| LiT | LND |
80-
|-------------------|--------------|
81-
| **v0.16.0-alpha** | v0.19.0-beta |
82-
| **v0.15.3-alpha** | v0.19.0-beta |
83-
| **v0.15.2-alpha** | v0.19.0-beta |
84-
| **v0.15.1-alpha** | v0.19.0-beta |
85-
| **v0.15.0-alpha** | v0.19.0-beta |
86-
| **v0.14.1-alpha** | v0.18.5-beta |
87-
| **v0.14.0-alpha** | v0.18.4-beta |
88-
| **v0.13.6-alpha** | v0.17.1-beta |
89-
| **v0.13.5-alpha** | v0.17.1-beta |
90-
| **v0.13.4-alpha** | v0.17.1-beta |
91-
| **v0.13.3-alpha** | v0.17.1-beta |
92-
| **v0.13.2-alpha** | v0.17.0-beta |
93-
| **v0.13.1-alpha** | v0.17.0-beta |
94-
| **v0.13.0-alpha** | v0.17.0-beta |
95-
| **v0.12.5-alpha** | v0.17.0-beta |
96-
| **v0.12.4-alpha** | v0.17.0-beta |
97-
| **v0.12.3-alpha** | v0.16.0-beta |
98-
| **v0.12.2-alpha** | v0.16.0-beta |
99-
| **v0.12.1-alpha** | v0.16.0-beta |
100-
| **v0.12.0-alpha** | v0.16.0-beta |
101-
| **v0.11.0-alpha** | v0.16.0-beta |
102-
| **v0.10.5-alpha** | v0.16.0-beta |
103-
| **v0.10.4-alpha** | v0.16.0-beta |
104-
| **v0.10.2-alpha** | v0.16.0-beta |
105-
| **v0.10.1-alpha** | v0.16.0-beta |
106-
| **v0.10.0-alpha** | v0.16.0-beta |
107-
| **v0.9.2-alpha** | v0.16.0-beta |
108-
| **v0.9.1-alpha** | v0.16.0-beta |
109-
| **v0.9.0-alpha** | v0.16.0-beta |
110-
| **v0.8.6-alpha** | v0.15.4-beta |
111-
| **v0.8.5-alpha** | v0.15.4-beta |
112-
| **v0.8.4-alpha** | v0.15.1-beta |
113-
| **v0.8.3-alpha** | v0.15.1-beta |
114-
| **v0.8.2-alpha** | v0.15.1-beta |
115-
| **v0.8.1-alpha** | v0.15.1-beta |
116-
| **v0.8.0-alpha** | v0.15.1-beta |
117-
| **v0.7.1-alpha** | v0.14.3-beta |
118-
| **v0.7.0-alpha** | v0.14.3-beta |
119-
| **v0.6.7-alpha** | v0.13.3-beta |
120-
| **v0.6.6-alpha** | v0.13.3-beta |
121-
| **v0.6.5-alpha** | v0.13.3-beta |
122-
| **v0.6.4-alpha** | v0.13.3-beta |
123-
| **v0.6.3-alpha** | v0.13.3-beta |
124-
| **v0.6.2-alpha** | v0.13.3-beta |
125-
| **v0.6.1-alpha** | v0.13.3-beta |
126-
| **v0.6.0-alpha** | v0.13.3-beta |
127-
| **v0.5.2-alpha** | v0.12.0-beta |
128-
| **v0.5.1-alpha** | v0.12.0-beta |
129-
| **v0.5.0-alpha** | v0.12.0-beta |
130-
| **v0.4.1-alpha** | v0.11.1-beta |
131-
| **v0.4.0-alpha** | v0.11.1-beta |
132-
| **v0.3.4-alpha** | v0.11.1-beta |
133-
| **v0.3.3-alpha** | v0.11.1-beta |
134-
| **v0.3.2-alpha** | v0.11.1-beta |
135-
| **v0.3.1-alpha** | v0.11.1-beta |
136-
| **v0.3.0-alpha** | v0.11.1-beta |
137-
| **v0.2.0-alpha** | v0.11.0-beta |
138-
139-
LiT offers two main operating modes, one in which [`lnd` is running inside the
140-
LiT process (called "lnd integrated mode", set by `lnd-mode=integrated` config
141-
option)](docs/config-lnd-integrated.md) and one in which [`lnd` is running in
142-
a standalone process on the same or remote machine (called "lnd remote mode",
143-
set by `lnd-mode=remote` config option)](docs/config-lnd-remote.md).
144-
145-
In addition to those main modes, the individual bundled daemons (Faraday, Loop
146-
and Pool) can be toggled to be integrated or remote as well, or as disabled.
147-
This offers a large number of possible configuration combinations, of which not
148-
all are fully supported due to technical reasons.
149-
150-
The following table shows the supported combinations:
67+
## Component Compatibility
68+
69+
This section describes version and mode compatibility across Lightning Terminal
70+
(LiT) and its component daemons.
71+
72+
### LND Version Compatibility
73+
74+
LiT can operate in two modes: [integrated](docs/config-lnd-integrated.md) and
75+
[remote](docs/config-lnd-remote.md). Version compatibility between LiT and `lnd`
76+
matters only when running in remote mode. The lnd version bundled in
77+
integrated mode is always compatible.
78+
79+
Each LiT release should specify the minimum compatible `lnd` version in its
80+
[GitHub release
81+
notes](https://github.com/lightninglabs/lightning-terminal/releases). If a
82+
release does not document compatibility, the required information is available
83+
in the archived compatibility table in
84+
[docs/compatibility.md](./docs/compatibility.md).
85+
86+
### Compatibility With Additional Daemons
87+
88+
LiT also bundles several additional daemons: Faraday, Loop, Pool and Taproot
89+
Assets. Each can be configured as integrated, remote or disabled. This creates
90+
many possible configurations, and not all combinations are supported due to
91+
technical constraints.
92+
93+
The following table lists supported combinations:
15194

15295
| | `lnd-mode=integrated` | `lnd-mode=remote` |
15396
|----------------------------------------|-----------------------|-------------------|

‎docs/compatibility.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# LND Version Compatibility With ***Remote Mode*** LiT
2+
3+
Full Lightning Terminal functionality can be dependent on running a compatible
4+
version of `lnd`. For new releases, the minimum required `lnd` version should be
5+
specified in the GitHub release notes. If a release note does not mention it
6+
(for example, older releases), refer to the archived compatibility table below.
7+
8+
This version compatibility dependency table is only relevant when running LiT in
9+
remote mode (meaning that `lnd-mode=remote` is set). It shows the **minimum**
10+
`lnd` version that can be used with different versions of `litd` (LiT). The
11+
bundled version will always come with the correct compatible versioning.
12+
13+
| LiT | min LND version |
14+
|-------------------|-----------------|
15+
| **v0.16.0-alpha** | v0.19.0-beta |
16+
| **v0.15.3-alpha** | v0.19.0-beta |
17+
| **v0.15.2-alpha** | v0.19.0-beta |
18+
| **v0.15.1-alpha** | v0.19.0-beta |
19+
| **v0.15.0-alpha** | v0.19.0-beta |
20+
| **v0.14.1-alpha** | v0.18.5-beta |
21+
| **v0.14.0-alpha** | v0.18.4-beta |
22+
| **v0.13.6-alpha** | v0.17.1-beta |
23+
| **v0.13.5-alpha** | v0.17.1-beta |
24+
| **v0.13.4-alpha** | v0.17.1-beta |
25+
| **v0.13.3-alpha** | v0.17.1-beta |
26+
| **v0.13.2-alpha** | v0.17.0-beta |
27+
| **v0.13.1-alpha** | v0.17.0-beta |
28+
| **v0.13.0-alpha** | v0.17.0-beta |
29+
| **v0.12.5-alpha** | v0.17.0-beta |
30+
| **v0.12.4-alpha** | v0.17.0-beta |
31+
| **v0.12.3-alpha** | v0.16.0-beta |
32+
| **v0.12.2-alpha** | v0.16.0-beta |
33+
| **v0.12.1-alpha** | v0.16.0-beta |
34+
| **v0.12.0-alpha** | v0.16.0-beta |
35+
| **v0.11.0-alpha** | v0.16.0-beta |
36+
| **v0.10.5-alpha** | v0.16.0-beta |
37+
| **v0.10.4-alpha** | v0.16.0-beta |
38+
| **v0.10.2-alpha** | v0.16.0-beta |
39+
| **v0.10.1-alpha** | v0.16.0-beta |
40+
| **v0.10.0-alpha** | v0.16.0-beta |
41+
| **v0.9.2-alpha** | v0.16.0-beta |
42+
| **v0.9.1-alpha** | v0.16.0-beta |
43+
| **v0.9.0-alpha** | v0.16.0-beta |
44+
| **v0.8.6-alpha** | v0.15.4-beta |
45+
| **v0.8.5-alpha** | v0.15.4-beta |
46+
| **v0.8.4-alpha** | v0.15.1-beta |
47+
| **v0.8.3-alpha** | v0.15.1-beta |
48+
| **v0.8.2-alpha** | v0.15.1-beta |
49+
| **v0.8.1-alpha** | v0.15.1-beta |
50+
| **v0.8.0-alpha** | v0.15.1-beta |
51+
| **v0.7.1-alpha** | v0.14.3-beta |
52+
| **v0.7.0-alpha** | v0.14.3-beta |
53+
| **v0.6.7-alpha** | v0.13.3-beta |
54+
| **v0.6.6-alpha** | v0.13.3-beta |
55+
| **v0.6.5-alpha** | v0.13.3-beta |
56+
| **v0.6.4-alpha** | v0.13.3-beta |
57+
| **v0.6.3-alpha** | v0.13.3-beta |
58+
| **v0.6.2-alpha** | v0.13.3-beta |
59+
| **v0.6.1-alpha** | v0.13.3-beta |
60+
| **v0.6.0-alpha** | v0.13.3-beta |
61+
| **v0.5.2-alpha** | v0.12.0-beta |
62+
| **v0.5.1-alpha** | v0.12.0-beta |
63+
| **v0.5.0-alpha** | v0.12.0-beta |
64+
| **v0.4.1-alpha** | v0.11.1-beta |
65+
| **v0.4.0-alpha** | v0.11.1-beta |
66+
| **v0.3.4-alpha** | v0.11.1-beta |
67+
| **v0.3.3-alpha** | v0.11.1-beta |
68+
| **v0.3.2-alpha** | v0.11.1-beta |
69+
| **v0.3.1-alpha** | v0.11.1-beta |
70+
| **v0.3.0-alpha** | v0.11.1-beta |
71+
| **v0.2.0-alpha** | v0.11.0-beta |

0 commit comments

Comments
 (0)