Skip to content

Commit 0d1e611

Browse files
committed
doc: document remote daemon mode
1 parent 977c63c commit 0d1e611

File tree

1 file changed

+36
-4
lines changed

1 file changed

+36
-4
lines changed

doc/config-lnd-remote.md

Lines changed: 36 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,14 +49,46 @@ Visit https://localhost:8443 to access LiT.
4949

5050
## Additional Configuration
5151

52-
The "remote" mode means that `lnd` is started as a standalone process, possibly on another
52+
The default "remote" mode means that `lnd` is started as a standalone process, possibly on another
5353
host, and `litd` connects to it, right after starting its UI server. Once the connection
5454
to the remote `lnd` node has been established, `litd` then goes ahead and starts
5555
`faraday`, `pool` and `loop` and connects them to that `lnd` node as well.
5656

57-
Currently the UI server cannot connect to `loop`, `pool` or `faraday` daemons
58-
that aren't running in the same process. But that feature will also be available
59-
in future versions.
57+
### Connecting LiT to a remote faraday node
58+
59+
To instruct LiT to not start its own integrated `faraday` daemon but instead
60+
connect to an existing node, use the following configuration options:
61+
62+
```text
63+
faraday-mode=remote
64+
remote.faraday.rpcserver=<externally-reachable-ip-address>:8465
65+
remote.faraday.macaroonpath=/some/folder/with/faraday/data/faraday.macaroon
66+
remote.faraday.tlscertpath=/some/folder/with/faraday/data/tls.cert
67+
```
68+
69+
### Connecting LiT to a remote loopd node
70+
71+
To instruct LiT to not start its own integrated `loopd` daemon but instead
72+
connect to an existing node, use the following configuration options:
73+
74+
```text
75+
loop-mode=remote
76+
remote.loop.rpcserver=<externally-reachable-ip-address>:11010
77+
remote.loop.macaroonpath=/some/folder/with/loop/data/loop.macaroon
78+
remote.loop.tlscertpath=/some/folder/with/loop/data/tls.cert
79+
```
80+
81+
### Connecting LiT to a remote poold node
82+
83+
To instruct LiT to not start its own integrated `poold` daemon but instead
84+
connect to an existing node, use the following configuration options:
85+
86+
```text
87+
pool-mode=remote
88+
remote.pool.rpcserver=<externally-reachable-ip-address>:12010
89+
remote.pool.macaroonpath=/some/folder/with/pool/data/pool.macaroon
90+
remote.pool.tlscertpath=/some/folder/with/pool/data/tls.cert
91+
```
6092

6193
## Use command line parameters only
6294

0 commit comments

Comments
 (0)