@@ -147,191 +147,24 @@ Application Options:
147
147
certificate (default: /Users/<username>/Library/Application Support/Lnd/letsencrypt)
148
148
```
149
149
150
- In addition to the LiT specific parameters, you must also provide configuration to the
151
- ` lnd ` , ` loop ` and ` faraday ` daemons. For ` lnd ` , each flag must be prefixed with ` lnd. `
152
- (ex: ` lnd.lnddir=~/.lnd ` ). Please see the
153
- [ sample-lnd.conf] ( https://github.com/lightningnetwork/lnd/blob/master/sample-lnd.conf )
154
- file for more details on the available parameters. Note that ` loopd ` and ` faraday ` will
155
- automatically connect to the in-process ` lnd ` node, so you do not need to provide them
156
- with any additional parameters unless you want to override them. If you do override them,
157
- be sure to add the ` loop. ` and ` faraday. ` prefixes.
150
+ ### Lnd mode
158
151
159
- Here is an example command to start ` litd ` on testnet with a local ` bitcoind ` node:
152
+ Starting with LiT ` v0.2.0-alpha ` , you now have the choice of either running an
153
+ ` lnd ` node in the same process as the UI (which is called the "integrated" ` lnd `
154
+ mode) or connect the UI to an already running ` lnd ` node (called "remote" mode).
160
155
161
- ```
162
- $ ./litd \
163
- --httpslisten=0.0.0.0:443 \
164
- --uipassword=My$trongP@ssword \
165
- --letsencrypt \
166
- --letsencrypthost=loop.merchant.com \
167
- --lnd.lnddir=/root/.lnd \
168
- --lnd.alias=merchant \
169
- --lnd.externalip=loop.merchant.com \
170
- --lnd.rpclisten=0.0.0.0:10009 \
171
- --lnd.listen=0.0.0.0:9735 \
172
- --lnd.bitcoin.active \
173
- --lnd.bitcoin.testnet \
174
- --lnd.bitcoin.node=bitcoind \
175
- --lnd.bitcoind.rpchost=localhost \
176
- --lnd.bitcoind.rpcuser=testnetuser \
177
- --lnd.bitcoind.rpcpass=testnetpw \
178
- --lnd.bitcoind.zmqpubrawblock=localhost:28332 \
179
- --lnd.bitcoind.zmqpubrawtx=localhost:28333 \
180
- --lnd.debuglevel=debug \
181
- --loop.loopoutmaxparts=5 \
182
- --faraday.min_monitored=48h
183
- ```
184
-
185
- You can also store the configuration in a persistent ` lnd.conf ` file so you do not need to
186
- type in the command line arguments every time you start the server. Just remember to use
187
- the appropriate prefixes as necessary.
188
-
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.
191
-
192
- Example ` lnd.conf ` :
193
-
194
- ```
195
- httpslisten=0.0.0.0:443
196
- letsencrypt=1
197
- letsencrypthost=loop.merchant.com
198
-
199
- lnd.lnddir=~/.lnd
200
- lnd.alias=merchant
201
- lnd.externalip=loop.merchant.com
202
- lnd.rpclisten=0.0.0.0:10009
203
- lnd.listen=0.0.0.0:9735
204
- lnd.debuglevel=debug
205
-
206
- lnd.bitcoin.active=1
207
- lnd.bitcoin.testnet=1
208
- lnd.bitcoin.node=bitcoind
209
-
210
- lnd.bitcoind.rpchost=localhost
211
- lnd.bitcoind.rpcuser=testnetuser
212
- lnd.bitcoind.rpcpass=testnetpw
213
- lnd.bitcoind.zmqpubrawblock=localhost:28332
214
- lnd.bitcoind.zmqpubrawtx=localhost:28333
215
-
216
- loop.loopoutmaxparts=5
217
-
218
- faraday.min_monitored=48h
219
-
220
- ```
221
-
222
- The default location for the ` lnd.conf ` file will depend on your operating system:
223
-
224
- - ** On MacOS** : ` ~/Library/Application Support/Lnd/lnd.conf `
225
- - ** On Linux** : ` ~/.lnd/lnd.conf `
226
- - ** On Windows** : ` ~/AppData/Roaming/Lnd/lnd.conf `
227
-
228
- ### Upgrade Existing Nodes
229
-
230
- If you already have existing ` lnd ` , ` loop ` , or ` faraday ` nodes, you can easily upgrade
231
- them to the LiT single executable while keeping all of your past data.
232
-
233
- For ` lnd ` :
234
-
235
- - if you use an ` lnd.conf ` file for configurations, add the ` lnd. ` prefix to each of the
236
- configuration parameters.
237
-
238
- Before:
239
-
240
- ```
241
- [Application Options]
242
- alias=merchant
243
- ```
244
-
245
- After:
246
-
247
- ```
248
- [Application Options]
249
- lnd.alias=merchant
250
- ```
251
-
252
- - if you use command line arguments for configuration, add the ` lnd. ` prefix to each
253
- argument to ` litd `
254
-
255
- Before:
256
-
257
- ```
258
- $ lnd --lnddir=~/.lnd --alias=merchant ...
259
- ```
260
-
261
- After:
262
-
263
- ```
264
- $ litd lnd.lnddir=~/.lnd --lnd.alias=merchant ...
265
- ```
266
-
267
- For ` loop ` :
268
-
269
- - if you use an ` loop.conf ` file for configurations, copy the parameters into the
270
- ` lnd.conf ` file that ` litd ` uses, and add the ` loop. ` prefix to each of the
271
- configuration parameters.
272
-
273
- Before: (in ` loop.conf ` )
274
-
275
- ```
276
- [Application Options]
277
- loopoutmaxparts=5
278
- ```
279
-
280
- After: (in ` lnd.conf ` )
281
-
282
- ```
283
- [Loop]
284
- loop.loopoutmaxparts=5
285
- ```
286
-
287
- - if you use command line arguments for configuration, add the ` loop. ` prefix to each
288
- argument to ` litd `
289
-
290
- Before:
291
-
292
- ```
293
- $ loop --loopoutmaxparts=5 --debuglevel=debug ...
294
- ```
295
-
296
- After:
297
-
298
- ```
299
- $ litd --loop.loopoutmaxparts=5 --loop.debuglevel=debug ...
300
- ```
301
-
302
- For ` faraday ` :
303
-
304
- - the standalone ` faraday ` daemon does not load configuration from a file, but you can now
305
- store the parameters into the ` lnd.conf ` file that ` litd ` uses. Just add the ` faraday. `
306
- prefix to each of the configuration parameters.
307
-
308
- Before: (from command line)
309
-
310
- ```
311
- $ faraday --min_monitored=48h
312
- ```
313
-
314
- After: (in ` lnd.conf ` )
315
-
316
- ```
317
- [Faraday]
318
- faraday.min_monitored=48h
319
- ```
320
-
321
- - if you use command line arguments for configuration, add the ` faraday. ` prefix to each
322
- argument to ` litd `
323
-
324
- Before:
325
-
326
- ```
327
- $ faraday --min_monitored=48h --debuglevel=debug ...
328
- ```
156
+ Because that single decision has an impact on the configuration options that
157
+ need to be used, the documentation has been split into two parts, each
158
+ explaining one mode in detail.
329
159
330
- After:
160
+ * Lnd mode ** "integrated"**
161
+ + Start everything (the UI, ` lnd ` , ` loop ` , ` faraday ` ) in one single process.
162
+ + [ Please read the ` lnd ` ** integrated** mode configuration guide here.] ( doc/config-lnd-integrated.md )
331
163
332
- ```
333
- $ litd --faraday.min_monitored=48h --faraday.debuglevel=debug...
334
- ```
164
+ * Lnd mode ** "remote"**
165
+ + Connect to a remote ` lnd ` instance, start the rest (the UI, ` loop ` ,
166
+ ` faraday ` ) in the same process.
167
+ + [ Please read the ` lnd ` ** remote** mode configuration guide here.] ( doc/config-lnd-remote.md )
335
168
336
169
### Troubleshooting
337
170
0 commit comments