Skip to content

Commit 75a26db

Browse files
authored
Merge pull request #113 from jamaljsr/update-readme
doc: update README doc
2 parents 75f0c83 + 6327337 commit 75a26db

File tree

1 file changed

+26
-12
lines changed

1 file changed

+26
-12
lines changed

README.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ archives as well.
4040

4141
| LiT | LND | Loop | Faraday |
4242
| ---------------- | ------------ | ----------- | ------------ |
43+
| **v0.1.1-alpha** | v0.11.0-beta | v0.8.1-beta | v0.2.0-alpha |
4344
| **v0.1.0-alpha** | v0.10.3-beta | v0.6.5-beta | v0.2.0-alpha |
4445

4546
## Usage
@@ -80,7 +81,26 @@ cd lightning-terminal
8081
make install
8182
```
8283

83-
This will produce the `litd` executable and add it to your `GOPATH`.
84+
This will produce the `litd` executable and add it to your `GOPATH`. The CLI binaries for
85+
`lncli`, `loop`, and `frcli` are not created by `make install`. You will need to download
86+
those binaries from the [lnd](https://github.com/lightningnetwork/lnd/releases),
87+
[loop](https://github.com/lightninglabs/loop/releases), and
88+
[faraday](https://github.com/lightninglabs/faraday/releases) repos manually.
89+
90+
#### Executing CLI Commands
91+
92+
When executing `loop` and `frcli` commands, you will need to specify the connection info
93+
since the daemons are now integrated into `lnd`'s GRPC server.
94+
95+
Examples:
96+
97+
```
98+
loop --rpcserver=localhost:10009 --tlscertpath=$HOME/.lnd/tls.cert --macaroonpath=$HOME/.lnd/data/chain/bitcoin/mainnet/admin.macaroon
99+
```
100+
101+
```
102+
frcli --rpcserver=localhost:10009 --tlscertpath=$HOME/.lnd/tls.cert --macaroonpath=$HOME/.lnd/data/chain/bitcoin/mainnet/admin.macaroon
103+
```
84104

85105
## Configuration
86106

@@ -124,7 +144,7 @@ Application Options:
124144
from the internet for this to work
125145
--letsencrypthost= the host name to create a Let's Encrypt certificate for'
126146
--letsencryptdir= the directory where the Let's Encrypt library will store its key and
127-
certificate (default: /Users/jamal/Library/Application Support/Lnd/letsencrypt)
147+
certificate (default: /Users/<username>/Library/Application Support/Lnd/letsencrypt)
128148
```
129149

130150
In addition to the LiT specific parameters, you must also provide configuration to the
@@ -166,14 +186,12 @@ You can also store the configuration in a persistent `lnd.conf` file so you do n
166186
type in the command line arguments every time you start the server. Just remember to use
167187
the appropriate prefixes as necessary.
168188

169-
Also make sure to include the `lnd` general options in the `[Application Options]` section
170-
because the section name `[Lnd]` is not unique anymore because of how we combine the
171-
configurations of all daemons. This will hopefully be fixed in a future release.
189+
Do not include section headers, such as `[Application Options]` or `[Bitcoin]`, in the
190+
config file. Doing so will produce an error on startup.
172191

173192
Example `lnd.conf`:
174193

175194
```
176-
[Application Options]
177195
httpslisten=0.0.0.0:443
178196
letsencrypt=1
179197
letsencrypthost=loop.merchant.com
@@ -185,22 +203,18 @@ lnd.rpclisten=0.0.0.0:10009
185203
lnd.listen=0.0.0.0:9735
186204
lnd.debuglevel=debug
187205
188-
[Bitcoin]
189-
lnd.bitcoin.active
190-
lnd.bitcoin.testnet
206+
lnd.bitcoin.active=1
207+
lnd.bitcoin.testnet=1
191208
lnd.bitcoin.node=bitcoind
192209
193-
[Bitcoind]
194210
lnd.bitcoind.rpchost=localhost
195211
lnd.bitcoind.rpcuser=testnetuser
196212
lnd.bitcoind.rpcpass=testnetpw
197213
lnd.bitcoind.zmqpubrawblock=localhost:28332
198214
lnd.bitcoind.zmqpubrawtx=localhost:28333
199215
200-
[Loop]
201216
loop.loopoutmaxparts=5
202217
203-
[Faraday]
204218
faraday.min_monitored=48h
205219
206220
```

0 commit comments

Comments
 (0)