Merge pull request #173 from lightninglabs/docs-fix

docs: multiple small fixes

Author: guggero

README.md

@@ -20,8 +20,8 @@ Download the latest binaries from the [releases](https://github.com/lightninglab
 ## Execution
 Run Lightning Terminal with a local `lnd` instance:
 
-```
-./litd --uipassword=UP48lm4Vjqxy<change_this_or_you_will_get_robbed>
+```shell
+⛰  ./litd --uipassword=UP48lm4Vjqxy<change_this_or_you_will_get_robbed>
 ```
 
 Visit https://localhost:8443 to access Terminal.
@@ -33,8 +33,8 @@ To use LiT with a remote `lnd` instance please [follow these instructions](./doc
 ## LND
 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:
 
-```
-make install tags="signrpc walletrpc chainrpc invoicesrpc"
+```shell
+⛰  make install tags="signrpc walletrpc chainrpc invoicesrpc"
 ```
 
 ## Interaction

doc/config-lnd-integrated.md

@@ -26,9 +26,9 @@ To see all available command line options, run `litd --help`.
 Here is an example command to start `litd` on testnet with a local `bitcoind`
 node:
 
-```shell script
-$ litd \
-  --httpslisten=0.0.0.0:443 \
+```shell
+⛰  litd \
+  --httpslisten=0.0.0.0:8443 \
   --uipassword=My$trongP@ssword \
   --letsencrypt \
   --letsencrypthost=loop.merchant.com \
@@ -71,7 +71,7 @@ Example `~/.lit/lit.conf`:
 
 ```text
 # Application Options
-httpslisten=0.0.0.0:443
+httpslisten=0.0.0.0:8443
 letsencrypt=true
 letsencrypthost=loop.merchant.com
 lnd-mode=integrated
@@ -165,14 +165,14 @@ For `lnd`:
 
   Before:
 
-  ```shell script
-  $ lnd --lnddir=~/.lnd --alias=merchant ...
+  ```shell
+  ⛰  lnd --lnddir=~/.lnd --alias=merchant ...
   ```
 
   After:
 
-  ```shell script
-  $ litd lnd.lnddir=~/.lnd --lnd.alias=merchant ...
+  ```shell
+  ⛰  litd lnd.lnddir=~/.lnd --lnd.alias=merchant ...
   ```
 
 For `loop`:
@@ -200,14 +200,14 @@ For `loop`:
 
   Before:
 
-  ```shell script
-  $ loop --loopoutmaxparts=5 --debuglevel=debug ...
+  ```shell
+  ⛰  loop --loopoutmaxparts=5 --debuglevel=debug ...
   ```
 
   After:
 
-  ```shell script
-  $ litd --loop.loopoutmaxparts=5 --loop.debuglevel=debug ...
+  ```shell
+  ⛰  litd --loop.loopoutmaxparts=5 --loop.debuglevel=debug ...
   ```
 
 For `faraday`:
@@ -218,8 +218,8 @@ For `faraday`:
 
   Before: (from command line)
 
-  ```shell script
-  $ faraday --min_monitored=48h
+  ```shell
+  ⛰  faraday --min_monitored=48h
   ```
 
   After: (in `lit.conf`)
@@ -234,14 +234,14 @@ For `faraday`:
 
   Before:
 
-  ```shell script
-  $ faraday --min_monitored=48h --debuglevel=debug ...
+  ```shell
+  ⛰  faraday --min_monitored=48h --debuglevel=debug ...
   ```
 
   After:
 
-  ```shell script
-  $ litd --faraday.min_monitored=48h --faraday.debuglevel=debug...
+  ```shell
+  ⛰  litd --faraday.min_monitored=48h --faraday.debuglevel=debug...
   ```
 
 ## Upgrading from LiT v0.1.1-alpha or earlier
@@ -297,8 +297,8 @@ The `lncli` commands in the "integrated" mode are the same as if `lnd` was
 running standalone. The `--lnddir` flag does not need to be specified as long
 as it is the default directory (`~/.lnd` on Linux).
 
-```shell script
-$ lncli --network=testnet getinfo
+```shell
+⛰  lncli --network=testnet getinfo
 ```
 
 ### Example `loop` command
@@ -308,17 +308,17 @@ runs on the same gRPC server as `lnd`. That's why we have to both specify the
 `host:port` as well as the TLS certificate of `lnd`. But `loopd` verifies its
 own macaroon, so we have to specify that one from the `.loop` directory.
 
-```shell script
-$ loop --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
+```shell
+⛰  loop --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
   --macaroonpath=~/.loop/testnet/loop.macaroon \
   quote out 500000
 ```
 
 You can easily create an alias for this by adding the following line to your
 `~/.bashrc` file:
 
-```shell script
-alias lit-loop="loop --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.loop/testnet/loop.macaroon"
+```shell
+⛰  alias lit-loop="loop --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.loop/testnet/loop.macaroon"
 ```
 
 ### Example `pool` command
@@ -327,33 +327,42 @@ Again, `poold` also runs on the same gRPC server as `lnd` and we have to specify
 the `host:port` and the TLS certificate of `lnd` but use the macaroon from the
 `.pool` directory.
 
-```shell script
-$ pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
+```shell
+⛰  pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
   --macaroonpath=~/.pool/testnet/pool.macaroon \
   accounts list
 ```
 
 You can easily create an alias for this by adding the following line to your
 `~/.bashrc` file:
 
-```shell script
-alias lit-pool="pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.pool/testnet/pool.macaroon"
+```shell
+⛰  alias lit-pool="pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.pool/testnet/pool.macaroon"
 ```
 
 ### Example `frcli` command
 
 Faraday's command line tool follows the same pattern as loop. We also have to
 specify the server and TLS flags for `lnd` but use `faraday`'s macaroon:
 
-```shell script
-$ frcli --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
+```shell
+⛰  frcli --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
   --macaroonpath=~/.faraday/testnet/faraday.macaroon \
   audit
 ```
 
 You can easily create an alias for this by adding the following line to your
 `~/.bashrc` file:
 
-```shell script
-alias lit-frcli="frcli --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.faraday/testnet/faraday.macaroon"
+```shell
+⛰  alias lit-frcli="frcli --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert --macaroonpath=~/.faraday/testnet/faraday.macaroon"
+```
+
+## Shutting down LiT
+
+In the integrated mode LiT can be shut down by stopping the integrated `lnd`
+node:
+
+```shell
+⛰  lncli stop
 ```

doc/config-lnd-remote.md

@@ -8,7 +8,7 @@ By default LiT assumes that `lnd` is running as a standalone process locally. Ho
 To connect Lightning Terminal to a remote LND instance first make sure your `lnd.conf`
 file contains the following additional configuration settings:
 
-```
+```text
 tlsextraip=<externally-reachable-ip-address>
 rpclisten=0.0.0.0:10009
 ```
@@ -36,16 +36,16 @@ depends on your operating system:
 Alternatively you can specify a different location by passing `--lit-dir=~/.lit`. After
 creating `lit.conf` populate it with the following configuration settings:
 
-```
+```text
 remote.lnd.rpcserver=<externally-reachable-ip-address>:10009
 remote.lnd.macaroondir=/some/folder/with/lnd/data
 remote.lnd.tlscertpath=/some/folder/with/lnd/data/tls.cert
 ```
 
 Run LiT:
 
-```
-./litd --uipassword=UP48lm4VjqxmOxB9X9stry6VTKBRQI
+```shell
+⛰  ./litd --uipassword=UP48lm4VjqxmOxB9X9stry6VTKBRQI
 ```
 
 Visit https://localhost:8443 to access LiT.
@@ -75,8 +75,8 @@ To see all available command line options, run `litd --help`.
 The most minimal example command to start `litd` and connect it to a local `lnd`
 node that is running with default configuration settings is:
 
-```shell script
-$ litd --uipassword=My$trongP@ssword
+```shell
+⛰  litd --uipassword=My$trongP@ssword
 ```
 
 All other command line flags are only needed to overwrite the default behavior.
@@ -85,9 +85,9 @@ Here is an example command to start `litd` connected to a testnet `lnd` that is
 running on another host and overwrites a few default settings in `loop`, `pool`,
 and `faraday` (optional):
 
-```shell script
-$ litd \
-  --httpslisten=0.0.0.0:443 \
+```shell
+⛰  litd \
+  --httpslisten=0.0.0.0:8443 \
   --uipassword=My$trongP@ssword \
   --letsencrypt \
   --letsencrypthost=loop.merchant.com \
@@ -139,7 +139,7 @@ running on another host and overwrites a few default settings in `loop`, `pool`,
 
 ```text
 # Application Options
-httpslisten=0.0.0.0:443
+httpslisten=0.0.0.0:8443
 uipassword=My$trongP@ssword
 letsencrypt=true
 letsencrypthost=loop.merchant.com
@@ -187,7 +187,7 @@ reasons for the extra flags. The examples assume that LiT is started with the fo
 configuration (only relevant parts shown here):
 
 ```text
-httpslisten=0.0.0.0:443
+httpslisten=0.0.0.0:8443
 lit-dir=~/.lit
 
 remote.lnd.network=testnet
@@ -197,7 +197,7 @@ remote.lnd.tlscertpath=/some/folder/with/lnd/data/tls.cert
 ```
 
 Because in the remote `lnd` mode all other LiT components (`loop`, `pool`,
-`faraday` and the UI server) listen on the same port (`443` in this example) and
+`faraday` and the UI server) listen on the same port (`8443` in this example) and
 use the same TLS certificate (`~/.lit/tls.cert` in this example), some command
 line calls now need some extra options that weren't necessary before.
 
@@ -213,8 +213,8 @@ implied by looking inside the default directories for that network. Or you speci
 The `lncli` commands in the "remote" mode are the same as if `lnd` was running standalone
 on a remote host. We need to specify all flags explicitly.
 
-```shell script
-$ lncli --rpcserver=some-other-host:10009 \
+```shell
+⛰  lncli --rpcserver=some-other-host:10009 \
   --tlscertpath=/some/folder/with/lnd/data/tls.cert \
   --macaroonpath=/some/folder/with/lnd/data/admin.macaroon \
   getinfo
@@ -227,17 +227,17 @@ the same port as the UI server. That's why we have to both specify the `host:por
 as the TLS certificate of LiT. But `loopd` verifies its own macaroon, so we have to
 specify that one from the `.loop` directory.
 
-```shell script
-$ loop --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert \
+```shell
+⛰  loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
   --macaroonpath=~/.loop/testnet/loop.macaroon \
   quote out 500000
 ```
 
 You can easily create an alias for this by adding the following line to your `~/.bashrc`
 file:
 
-```shell script
-alias lit-loop="loop --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.loop/testnet/loop.macaroon"
+```shell
+⛰  alias lit-loop="loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.loop/testnet/loop.macaroon"
 ```
 
 ### Example `pool` command
@@ -246,33 +246,45 @@ Again, `poold` also runs on the same port as the UI server and we have to
 specify the `host:port` and the TLS certificate of LiT but use the macaroon from
 the `.pool` directory.
 
-```shell script
-$ pool --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert \
+```shell
+⛰  pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
   --macaroonpath=~/.pool/testnet/pool.macaroon \
   accounts list
 ```
 
 You can easily create an alias for this by adding the following line to your
 `~/.bashrc` file:
 
-```shell script
-alias lit-pool="pool --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.pool/testnet/pool.macaroon"
+```shell
+⛰  alias lit-pool="pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.pool/testnet/pool.macaroon"
 ```
 
 ### Example `frcli` command
 
 Faraday's command line tool follows the same pattern as loop. We also have to specify the
 server and TLS flags for `lnd` but use `faraday`'s macaroon:
 
-```shell script
-$ frcli --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert \
+```shell
+⛰  frcli --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
   --macaroonpath=~/.faraday/testnet/faraday.macaroon \
   audit
 ```
 
 You can easily create an alias for this by adding the following line to your `~/.bashrc`
 file:
 
-```shell script
-alias lit-frcli="frcli --rpcserver=localhost:443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.faraday/testnet/faraday.macaroon"
+```shell
+⛰  alias lit-frcli="frcli --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --macaroonpath=~/.faraday/testnet/faraday.macaroon"
+```
+
+## Shutting down LiT
+
+In the remote mode, there is no explicit command for stopping LiT yet. But a
+clean shutdown can be achieved by either pressing `<Ctrl> + c` in the terminal
+where LiT is running. Or, if LiT is running in the background, the following
+command can be used to send an interrupt signal which will trigger the clean
+shutdown:
+
+```shell
+⛰  kill -s INT $(pidof litd)
 ```