Skip to content

Commit c3ff7e4

Browse files
committed
README: add config compat matrix
1 parent 88486df commit c3ff7e4

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,29 @@ Lightning Terminal is backwards compatible with `lnd` back to version v0.13.3-be
8686
| **v0.3.0-alpha** | v0.11.1-beta |
8787
| **v0.2.0-alpha** | v0.11.0-beta |
8888

89+
LiT offers two main operating modes, one in which [`lnd` is running inside the
90+
LiT process (called "lnd integrated mode", set by `lnd-mode=integrated` config
91+
option)](doc/config-lnd-integrated.md) and one in which [`lnd` is running in
92+
a standalone process on the same or remote machine (called "lnd remote mode",
93+
set by `lnd-mode=remote` config option)](doc/config-lnd-remote.md).
94+
95+
In addition to those main modes, the individual bundled daemons (Faraday, Loop
96+
and Pool) can be toggled to be integrated or remote as well. This offers a
97+
large number of possible configuration combinations, of which not all are
98+
fully supported due to technical reasons.
99+
100+
The following table shows the supported combinations:
101+
102+
| | `lnd-mode=integrated` | `lnd-mode=remote` |
103+
|----------------------------------------|-----------------------|-------------------|
104+
| `faraday-mode=integrated` | X | X |
105+
| `loop-mode=integrated` | X | X |
106+
| `pool-mode=integrated` | X | X |
107+
| `faraday-mode=remote` | | X |
108+
| `loop-mode=remote` | | X |
109+
| `pool-mode=remote` | | X |
110+
| `lnd` running in "stateless init" mode | X | |
111+
89112
## Daemon Versions packaged with LiT
90113

91114
| LiT | LND | Loop | Faraday | Pool |

0 commit comments

Comments
 (0)