Skip to content

Commit a1ef642

Browse files
authored
Merge pull request #1179 from lightninglabs/wip/readme-cleanup
Cleanup and streamline README formatting and version guidance
2 parents e7538e4 + 62bf127 commit a1ef642

File tree

2 files changed

+158
-168
lines changed

2 files changed

+158
-168
lines changed

README.md

Lines changed: 87 additions & 168 deletions
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,34 @@
22

33
![CI](https://github.com/lightninglabs/lightning-terminal/workflows/CI/badge.svg)
44

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

78
![screenshot](./app/src/assets/images/screenshot.png)
89

910
## Features
11+
1012
- Visualize your channels and balances
11-
- Perform submarine swaps via the [Lightning Loop](https://lightning.engineering/loop) service
13+
- Perform submarine swaps via
14+
the [Lightning Loop](https://lightning.engineering/loop) service
1215
- Classify channels according to your node's operating mode
13-
- Run a single binary that integrates [`loopd`](https://github.com/lightninglabs/loop),
16+
- Run a single binary that integrates
17+
[`loopd`](https://github.com/lightninglabs/loop),
1418
[`poold`](https://github.com/lightninglabs/pool) and
1519
[`faraday`](https://github.com/lightninglabs/faraday) daemons all in one
1620
- Access a preview release of the Pool UI
1721
- Use Pool to earn sats by opening channels to those needing inbound liquidity
1822

1923
## Installation
20-
Download the latest binaries from the [releases](https://github.com/lightninglabs/lightning-terminal/releases) page.
2124

22-
Additionally, you can find detailed instructions on the [docs.lightning.engineering](https://docs.lightning.engineering/lightning-network-tools/lightning-terminal/get-lit) page.
25+
Download the latest binaries from the [releases](https://github.com/lightninglabs/lightning-terminal/releases)
26+
page.
27+
28+
Additionally, you can find detailed instructions on the [docs.lightning.engineering](https://docs.lightning.engineering/lightning-network-tools/lightning-terminal/get-lit)
29+
page.
2330

2431
## Execution
32+
2533
Run Lightning Terminal with a local `lnd` instance:
2634

2735
```shell
@@ -30,206 +38,117 @@ Run Lightning Terminal with a local `lnd` instance:
3038

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

33-
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.
41+
Note that a password with a minimum of 8 characters is required to run Lightning
42+
Terminal. In a production environment, it's recommended that you store this
43+
password as an environment variable to avoid it being recorded in the command
44+
history.
3445

35-
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).
46+
To use LiT with a remote `lnd` instance
47+
please [follow these instructions](./docs/config-lnd-remote.md). If you would
48+
like to replace your existing LND instance with the one integrated within LiT
49+
please see [configuring Terminal](./docs/config-lnd-integrated.md).
3650

3751
## LND
38-
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:
52+
53+
Note that LiT requires `lnd` to be built with **all of its subservers** and
54+
requires running at least v0.11.0. Download the
55+
latest [official release binary](https://github.com/lightningnetwork/lnd/releases/latest)
56+
or build `lnd` from source by following
57+
the [installation instructions](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md).
58+
If you choose to build `lnd` from source, use the following command to enable
59+
all the relevant subservers:
3960

4061
```shell
4162
⛰ make install tags="signrpc walletrpc chainrpc invoicesrpc"
4263
```
4364

4465
## Interaction
45-
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
46-
[Let's Encrypt Configuration](./docs/letsencrypt.md) doc for instructions on how to configure this.
66+
67+
If you plan to run LiT on a remote machine but access the web-interface from
68+
your computer you may not want to deal with self-signed certificate browser
69+
warnings. To avoid these warnings configure the HTTP server to use a certificate
70+
from [Let's Encrypt](https://letsencrypt.org/). View the
71+
[Let's Encrypt Configuration](./docs/letsencrypt.md) doc for instructions on how
72+
to configure this.
4773

4874
## Upgrading
49-
If you used command line arguments with previous versions then you don't need to change anything when upgrading.
5075

51-
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:
76+
If you used command line arguments with previous versions then you don't need to
77+
change anything when upgrading.
78+
79+
To upgrade from v0.1.1-alpha or earlier simply create a `lit.conf` file in your
80+
LiT directory. The default location LiT uses depends on your operating system:
81+
5282
- MacOS: `~/Library/Application Support/Lit/lit.conf`
5383
- Linux: `~/.lit/lit.conf`
5484
- Windows: `~/AppData/Roaming/Lit/lit.conf`
5585

56-
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`).
86+
Move all the configuration settings specific to LiT from `lnd.conf` to
87+
`lit.conf` and remove any previous LiT-specific customizations from the
88+
configuration settings in `lnd.conf`. Note that any section headers (
89+
`[ Example ]`) in `lit.conf` should be removed or changed to comments (
90+
`# Example`).
5791

5892
## Usage
59-
Read the [walkthrough](docs/WALKTHROUGH.md) document to learn more about how to use LiT.
93+
94+
Read the [walkthrough](docs/WALKTHROUGH.md) document to learn more about how to
95+
use LiT.
6096

6197
## Troubleshooting
62-
If you encounter any issues please see our [troubleshooting guide](./docs/troubleshooting.md).
98+
99+
If you encounter any issues please see
100+
our [troubleshooting guide](./docs/troubleshooting.md).
63101

64102
## Build from source
65-
If you’d prefer to compile from source code please follow [these instructions](./docs/compile.md).
66-
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:
103+
104+
If you’d prefer to compile from source code please
105+
follow [these instructions](./docs/compile.md).
106+
107+
## Component Compatibility
108+
109+
This section describes version and mode compatibility across Lightning Terminal
110+
(LiT) and its component daemons.
111+
112+
### LND Version Compatibility
113+
114+
LiT can operate in two modes: [integrated](docs/config-lnd-integrated.md) and
115+
[remote](docs/config-lnd-remote.md). Version compatibility between LiT and `lnd`
116+
matters only when running in remote mode. The lnd version bundled in
117+
integrated mode is always compatible.
118+
119+
Each LiT release should specify the minimum compatible `lnd` version in its
120+
[GitHub release
121+
notes](https://github.com/lightninglabs/lightning-terminal/releases). If a
122+
release does not document compatibility, the required information is available
123+
in the archived compatibility table in
124+
[docs/compatibility.md](./docs/compatibility.md).
125+
126+
### Compatibility With Additional Daemons
127+
128+
LiT also bundles several additional daemons: Faraday, Loop, Pool and Taproot
129+
Assets. Each can be configured as integrated, remote or disabled. This creates
130+
many possible configurations, and not all combinations are supported due to
131+
technical constraints.
132+
133+
The following table lists supported combinations:
151134

152135
| | `lnd-mode=integrated` | `lnd-mode=remote` |
153136
|----------------------------------------|-----------------------|-------------------|
154137
| `faraday-mode=integrated` | X | X |
155138
| `loop-mode=integrated` | X | X |
156139
| `pool-mode=integrated` | X | X |
157-
| `taproot-assets-mode=integrated` | X | X |
140+
| `taproot-assets-mode=integrated` | X | X |
158141
| `faraday-mode=remote` | | X |
159142
| `loop-mode=remote` | | X |
160143
| `pool-mode=remote` | | X |
161-
| `taproot-assets-mode=remote` | | X |
144+
| `taproot-assets-mode=remote` | | X |
162145
| `faraday-mode=disable` | X | X |
163146
| `loop-mode=disable` | X | X |
164147
| `pool-mode=disable` | X | X |
165-
| `taproot-assets-mode=disable` | X | X |
148+
| `taproot-assets-mode=disable` | X | X |
166149
| `lnd` running in "stateless init" mode | X | |
167150

168151
NOTE: Taproot Assets **Channel** functionality is only available when both `lnd`
169152
and `tapd` are running in the same process (by setting both
170153
`lnd-mode=integrated` and `taproot-assets-mode=integrated`). Remote mode support
171154
will be added in the future.
172-
173-
## Daemon Versions packaged with LiT
174-
175-
| LiT | LND | Loop | Faraday | Pool | Taproot Assets |
176-
|-------------------|--------------|--------------|---------------|--------------|----------------|
177-
| **v0.16.0-alpha** | v0.20.0-beta | v0.31.6-beta | v0.2.16-alpha | v0.6.6-beta | v0.7.0-alpha |
178-
| **v0.15.3-alpha** | v0.19.3-beta | v0.31.5-beta | v0.2.16-alpha | v0.6.6-beta | v0.6.1-alpha |
179-
| **v0.15.2-alpha** | v0.19.3-beta | v0.31.2-beta | v0.2.16-alpha | v0.6.6-beta | v0.6.1-alpha |
180-
| **v0.15.1-alpha** | v0.19.2-beta | v0.31.2-beta | v0.2.16-alpha | v0.6.6-beta | v0.6.1-alpha |
181-
| **v0.15.0-alpha** | v0.19.1-beta | v0.31.2-beta | v0.2.16-alpha | v0.6.6-beta | v0.6.0-alpha |
182-
| **v0.14.1-alpha** | v0.18.5-beta | v0.29.0-beta | v0.2.14-alpha | v0.6.5-beta | v0.5.1-alpha |
183-
| **v0.14.0-alpha** | v0.18.4-beta | v0.29.0-beta | v0.2.13-alpha | v0.6.5-beta | v0.5.0-alpha |
184-
| **v0.13.6-alpha** | v0.18.3-beta | v0.28.8-beta | v0.2.13-alpha | v0.6.5-beta | v0.4.1-alpha |
185-
| **v0.13.5-alpha** | v0.18.3-beta | v0.28.8-beta | v0.2.13-alpha | v0.6.5-beta | v0.4.1-alpha |
186-
| **v0.13.4-alpha** | v0.18.3-beta | v0.28.7-beta | v0.2.13-alpha | v0.6.5-beta | v0.4.1-alpha |
187-
| **v0.13.3-alpha** | v0.18.2-beta | v0.28.6-beta | v0.2.13-alpha | v0.6.5-beta | v0.4.1-alpha |
188-
| **v0.13.2-alpha** | v0.18.2-beta | v0.28.5-beta | v0.2.13-alpha | v0.6.5-beta | v0.3.3-alpha |
189-
| **v0.13.1-alpha** | v0.18.1-beta | v0.28.5-beta | v0.2.13-alpha | v0.6.5-beta | v0.3.3-alpha |
190-
| **v0.13.0-alpha** | v0.18.0-beta | v0.28.5-beta | v0.2.13-alpha | v0.6.5-beta | v0.3.3-alpha |
191-
| **v0.12.5-alpha** | v0.17.5-beta | v0.28.1-beta | v0.2.13-alpha | v0.6.4-beta | v0.3.3-alpha |
192-
| **v0.12.4-alpha** | v0.17.4-beta | v0.28.0-beta | v0.2.13-alpha | v0.6.4-beta | v0.3.3-alpha |
193-
| **v0.12.3-alpha** | v0.17.4-beta | v0.27.0-beta | v0.2.11-alpha | v0.6.4-beta | v0.3.3-alpha |
194-
| **v0.12.2-alpha** | v0.17.3-beta | v0.26.6-beta | v0.2.11-alpha | v0.6.4-beta | v0.3.2-alpha |
195-
| **v0.12.1-alpha** | v0.17.1-beta | v0.26.5-beta | v0.2.11-alpha | v0.6.4-beta | v0.3.1-alpha |
196-
| **v0.12.0-alpha** | v0.17.0-beta | v0.26.4-beta | v0.2.11-alpha | v0.6.4-beta | v0.3.0-alpha |
197-
| **v0.11.0-alpha** | v0.17.0-beta | v0.26.3-beta | v0.2.11-alpha | v0.6.4-beta | v0.2.3-alpha |
198-
| **v0.10.5-alpha** | v0.16.4-beta | v0.26.2-beta | v0.2.11-alpha | v0.6.4-beta | v0.2.3-alpha |
199-
| **v0.10.4-alpha** | v0.16.4-beta | v0.25.2-beta | v0.2.11-alpha | v0.6.4-beta | v0.2.3-alpha |
200-
| **v0.10.2-alpha** | v0.16.4-beta | v0.25.2-beta | v0.2.11-alpha | v0.6.4-beta | v0.2.2-alpha |
201-
| **v0.10.1-alpha** | v0.16.3-beta | v0.24.1-beta | v0.2.11-alpha | v0.6.4-beta | v0.2.0-alpha |
202-
| **v0.10.0-alpha** | v0.16.2-beta | v0.23.0-beta | v0.2.11-alpha | v0.6.2-beta | v0.2.0-alpha |
203-
| **v0.9.2-alpha** | v0.16.2-beta | v0.23.0-beta | v0.2.11-alpha | v0.6.2-beta | n/a |
204-
| **v0.9.1-alpha** | v0.16.1-beta | v0.23.0-beta | v0.2.11-alpha | v0.6.2-beta | n/a |
205-
| **v0.9.0-alpha** | v0.16.0-beta | v0.22.0-beta | v0.2.10-alpha | v0.6.2-beta | n/a |
206-
| **v0.8.6-alpha** | v0.15.5-beta | v0.21.0-beta | v0.2.9-alpha | v0.6.1-beta | n/a |
207-
| **v0.8.5-alpha** | v0.15.5-beta | v0.20.2-beta | v0.2.9-alpha | v0.6.1-beta | n/a |
208-
| **v0.8.4-alpha** | v0.15.5-beta | v0.20.1-beta | v0.2.9-alpha | v0.5.8-alpha | n/a |
209-
| **v0.8.3-alpha** | v0.15.4-beta | v0.20.1-beta | v0.2.8-alpha | v0.5.8-alpha | n/a |
210-
| **v0.8.2-alpha** | v0.15.3-beta | v0.20.1-beta | v0.2.8-alpha | v0.5.8-alpha | n/a |
211-
| **v0.8.1-alpha** | v0.15.2-beta | v0.20.1-beta | v0.2.8-alpha | v0.5.8-alpha | n/a |
212-
| **v0.8.0-alpha** | v0.15.1-beta | v0.20.1-beta | v0.2.8-alpha | v0.5.8-alpha | n/a |
213-
| **v0.7.1-alpha** | v0.15.0-beta | v0.19.1-beta | v0.2.8-alpha | v0.5.7-alpha | n/a |
214-
| **v0.7.0-alpha** | v0.15.0-beta | v0.19.1-beta | v0.2.8-alpha | v0.5.7-alpha | n/a |
215-
| **v0.6.7-alpha** | v0.14.3-beta | v0.18.0-beta | v0.2.7-alpha | v0.5.6-alpha | n/a |
216-
| **v0.6.6-alpha** | v0.14.3-beta | v0.18.0-beta | v0.2.7-alpha | v0.5.6-alpha | n/a |
217-
| **v0.6.5-alpha** | v0.14.2-beta | v0.15.1-beta | v0.2.7-alpha | v0.5.5-alpha | n/a |
218-
| **v0.6.4-alpha** | v0.14.2-beta | v0.15.1-beta | v0.2.7-alpha | v0.5.4-alpha | n/a |
219-
| **v0.6.3-alpha** | v0.14.2-beta | v0.15.1-beta | v0.2.7-alpha | v0.5.4-alpha | n/a |
220-
| **v0.6.2-alpha** | v0.14.1-beta | v0.15.1-beta | v0.2.7-alpha | v0.5.4-alpha | n/a |
221-
| **v0.6.1-alpha** | v0.14.1-beta | v0.15.1-beta | v0.2.7-alpha | v0.5.2-alpha | n/a |
222-
| **v0.5.3-alpha** | v0.13.3-beta | v0.14.1-beta | v0.2.6-alpha | v0.5.0-alpha | n/a |
223-
| **v0.5.2-alpha** | v0.13.3-beta | v0.14.1-beta | v0.2.6-alpha | v0.5.0-alpha | n/a |
224-
| **v0.5.1-alpha** | v0.13.0-beta | v0.14.1-beta | v0.2.6-alpha | v0.5.0-alpha | n/a |
225-
| **v0.5.0-alpha** | v0.13.0-beta | v0.14.1-beta | v0.2.6-alpha | v0.5.0-alpha | n/a |
226-
| **v0.4.1-alpha** | v0.12.1-beta | v0.11.4-beta | v0.2.3-alpha | v0.4.4-alpha | n/a |
227-
| **v0.4.0-alpha** | v0.12.0-beta | v0.11.2-beta | v0.2.3-alpha | v0.4.3-alpha | n/a |
228-
| **v0.3.4-alpha** | v0.11.1-beta | v0.11.2-beta | v0.2.2-alpha | v0.3.4-alpha | n/a |
229-
| **v0.3.3-alpha** | v0.11.1-beta | v0.11.2-beta | v0.2.2-alpha | v0.3.4-alpha | n/a |
230-
| **v0.3.2-alpha** | v0.11.1-beta | v0.11.1-beta | v0.2.2-alpha | v0.3.4-alpha | n/a |
231-
| **v0.3.1-alpha** | v0.11.1-beta | v0.11.1-beta | v0.2.2-alpha | v0.3.3-alpha | n/a |
232-
| **v0.3.0-alpha** | v0.11.1-beta | v0.11.0-beta | v0.2.2-alpha | v0.3.2-alpha | n/a |
233-
| **v0.2.0-alpha** | v0.11.1-beta | v0.10.0-beta | v0.2.1-alpha | n/a | n/a |
234-
| **v0.1.1-alpha** | v0.11.0-beta | v0.8.1-beta | v0.2.0-alpha | n/a | n/a |
235-
| **v0.1.0-alpha** | v0.10.3-beta | v0.6.5-beta | v0.2.0-alpha | n/a | n/a |

0 commit comments

Comments
 (0)