Skip to content

Commit 8374b6d

Browse files
committed
doc: use default 8443 port in examples
To make the example commands less confusing, we use the default port 8443 instead of the custom 443 port everywhere. Fixes #170.
1 parent 4cb0f1c commit 8374b6d

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

doc/config-lnd-integrated.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ node:
2828

2929
```shell script
3030
$ litd \
31-
--httpslisten=0.0.0.0:443 \
31+
--httpslisten=0.0.0.0:8443 \
3232
--uipassword=My$trongP@ssword \
3333
--letsencrypt \
3434
--letsencrypthost=loop.merchant.com \
@@ -71,7 +71,7 @@ Example `~/.lit/lit.conf`:
7171

7272
```text
7373
# Application Options
74-
httpslisten=0.0.0.0:443
74+
httpslisten=0.0.0.0:8443
7575
letsencrypt=true
7676
letsencrypthost=loop.merchant.com
7777
lnd-mode=integrated

doc/config-lnd-remote.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ and `faraday` (optional):
8787

8888
```shell script
8989
$ litd \
90-
--httpslisten=0.0.0.0:443 \
90+
--httpslisten=0.0.0.0:8443 \
9191
--uipassword=My$trongP@ssword \
9292
--letsencrypt \
9393
--letsencrypthost=loop.merchant.com \
@@ -139,7 +139,7 @@ running on another host and overwrites a few default settings in `loop`, `pool`,
139139

140140
```text
141141
# Application Options
142-
httpslisten=0.0.0.0:443
142+
httpslisten=0.0.0.0:8443
143143
uipassword=My$trongP@ssword
144144
letsencrypt=true
145145
letsencrypthost=loop.merchant.com
@@ -187,7 +187,7 @@ reasons for the extra flags. The examples assume that LiT is started with the fo
187187
configuration (only relevant parts shown here):
188188

189189
```text
190-
httpslisten=0.0.0.0:443
190+
httpslisten=0.0.0.0:8443
191191
lit-dir=~/.lit
192192
193193
remote.lnd.network=testnet
@@ -197,7 +197,7 @@ remote.lnd.tlscertpath=/some/folder/with/lnd/data/tls.cert
197197
```
198198

199199
Because in the remote `lnd` mode all other LiT components (`loop`, `pool`,
200-
`faraday` and the UI server) listen on the same port (`443` in this example) and
200+
`faraday` and the UI server) listen on the same port (`8443` in this example) and
201201
use the same TLS certificate (`~/.lit/tls.cert` in this example), some command
202202
line calls now need some extra options that weren't necessary before.
203203

@@ -228,7 +228,7 @@ as the TLS certificate of LiT. But `loopd` verifies its own macaroon, so we have
228228
specify that one from the `.loop` directory.
229229

230230
```shell script
231-
$ loop --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert \
231+
$ loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
232232
--macaroonpath=~/.loop/testnet/loop.macaroon \
233233
quote out 500000
234234
```
@@ -237,7 +237,7 @@ You can easily create an alias for this by adding the following line to your `~/
237237
file:
238238

239239
```shell script
240-
alias lit-loop="loop --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.loop/testnet/loop.macaroon"
240+
alias lit-loop="loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.loop/testnet/loop.macaroon"
241241
```
242242

243243
### Example `pool` command
@@ -247,7 +247,7 @@ specify the `host:port` and the TLS certificate of LiT but use the macaroon from
247247
the `.pool` directory.
248248

249249
```shell script
250-
$ pool --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert \
250+
$ pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
251251
--macaroonpath=~/.pool/testnet/pool.macaroon \
252252
accounts list
253253
```
@@ -256,7 +256,7 @@ You can easily create an alias for this by adding the following line to your
256256
`~/.bashrc` file:
257257

258258
```shell script
259-
alias lit-pool="pool --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.pool/testnet/pool.macaroon"
259+
alias lit-pool="pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.pool/testnet/pool.macaroon"
260260
```
261261

262262
### Example `frcli` command
@@ -265,7 +265,7 @@ Faraday's command line tool follows the same pattern as loop. We also have to sp
265265
server and TLS flags for `lnd` but use `faraday`'s macaroon:
266266

267267
```shell script
268-
$ frcli --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert \
268+
$ frcli --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
269269
--macaroonpath=~/.faraday/testnet/faraday.macaroon \
270270
audit
271271
```
@@ -274,5 +274,5 @@ You can easily create an alias for this by adding the following line to your `~/
274274
file:
275275

276276
```shell script
277-
alias lit-frcli="frcli --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.faraday/testnet/faraday.macaroon"
277+
alias lit-frcli="frcli --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.faraday/testnet/faraday.macaroon"
278278
```

0 commit comments

Comments
 (0)