doc: unify shell code block formatting

The code blocks aren't displayed correctly in GitBook when using the
"shell script" markup hint. We unify all code blocks to use the same
"shell" hint. While doing so, we also use an explicit unicode character
to represent the shell. This should make it more clear that the
character isn't part of the command itself.
This commit is contained in:
Oliver Gugger 2021-01-18 15:38:46 +01:00
parent ae63d9d5fe
commit a0190334fd
No known key found for this signature in database
GPG key ID: 8E4256593F177720
6 changed files with 80 additions and 79 deletions

View file

@ -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

View file

@ -26,8 +26,8 @@ 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 \
```shell
litd \
--httpslisten=0.0.0.0:8443 \
--uipassword=My$trongP@ssword \
--letsencrypt \
@ -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,8 +308,8 @@ 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
```
@ -317,8 +317,8 @@ $ loop --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
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,8 +327,8 @@ 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
```
@ -336,8 +336,8 @@ $ pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
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
@ -345,8 +345,8 @@ alias lit-pool="pool --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert -
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
```
@ -354,8 +354,8 @@ $ frcli --rpcserver=localhost:10009 --tlscertpath=~/.lnd/tls.cert \
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

View file

@ -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,7 +36,7 @@ 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
@ -44,8 +44,8 @@ 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,8 +85,8 @@ 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 \
```shell
litd \
--httpslisten=0.0.0.0:8443 \
--uipassword=My$trongP@ssword \
--letsencrypt \
@ -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,8 +227,8 @@ 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:8443 --tlscertpath=~/.lit/tls.cert \
```shell
loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
--macaroonpath=~/.loop/testnet/loop.macaroon \
quote out 500000
```
@ -236,8 +236,8 @@ $ loop --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
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:8443 --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,8 +246,8 @@ 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:8443 --tlscertpath=~/.lit/tls.cert \
```shell
pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
--macaroonpath=~/.pool/testnet/pool.macaroon \
accounts list
```
@ -255,8 +255,8 @@ $ pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
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:8443 --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
@ -264,8 +264,8 @@ alias lit-pool="pool --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert --
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:8443 --tlscertpath=~/.lit/tls.cert \
```shell
frcli --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
--macaroonpath=~/.faraday/testnet/faraday.macaroon \
audit
```
@ -273,8 +273,8 @@ $ frcli --rpcserver=localhost:8443 --tlscertpath=~/.lit/tls.cert \
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:8443 --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

View file

@ -54,14 +54,15 @@ These can be provided on the command line or via the `lit.conf` file.
Command Line:
`$ litd --letsencrypt --letsencrypthost=terminal.mydomain.com`
```shell
⛰ litd --letsencrypt --letsencrypthost=terminal.mydomain.com
```
Configuration file (`litd.conf`):
```
```text
--letsencrypt=true
--letsencrypthost=terminal.mydomain.com
```
## Example commands for interacting with the command line
@ -73,7 +74,7 @@ Let's go through an example for each of the command line tools and will explain
reasons for the extra flags. The examples assume that LiT is started with the following
configuration (only relevant parts shown here):
```
```text
httpslisten=0.0.0.0:8443
letsencrypt=1
letsencrypthost=terminal.mydomain.com
@ -87,8 +88,8 @@ lnd.bitcoin.testnet=true
The `lncli` commands in the "integrated" mode are the same as if `lnd` was running
standalone.
```shell script
$ lncli --network=testnet getinfo
```shell
lncli --network=testnet getinfo
```
### Example `loop` command
@ -97,8 +98,8 @@ Since `loopd` also runs on the same gRPC server as `lnd`, we have to specify the
**LetEncrypt** `host:port` and TLS certificate. But `loopd` verifies its own macaroon, so
we have to specify that one from the `.loop` directory.
```shell script
$ loop \
```shell
loop \
--rpcserver=terminal.mydomain.com:8443 \
--tlscertpath=~/.lit/letsencrypt/terminal.mydomain.com \
--macaroonpath=~/.loop/testnet/loop.macaroon \
@ -108,8 +109,8 @@ $ loop \
You can easily create an alias for this by adding the following line to your `~/.bashrc`
file:
```shell script
alias lit-loop="loop --rpcserver=terminal.mydomain.com:8443 --tlscertpath=~/.lit/letsencrypt/terminal.mydomain.com --macaroonpath=~/.loop/testnet/loop.macaroon"
```shell
alias lit-loop="loop --rpcserver=terminal.mydomain.com:8443 --tlscertpath=~/.lit/letsencrypt/terminal.mydomain.com --macaroonpath=~/.loop/testnet/loop.macaroon"
```
### Example `pool` command
@ -118,8 +119,8 @@ Since `poold` also runs on the same gRPC server as `lnd`, we have to specify the
**LetEncrypt** `host:port` and TLS certificate. But `poold` verifies its own
macaroon, so we have to specify that one from the `.pool` directory.
```shell script
$ pool \
```shell
pool \
--rpcserver=terminal.mydomain.com:8443 \
--tlscertpath=~/.lit/letsencrypt/terminal.mydomain.com \
--macaroonpath=~/.pool/testnet/pool.macaroon \
@ -129,8 +130,8 @@ $ pool \
You can easily create an alias for this by adding the following line to your
`~/.bashrc` file:
```shell script
alias lit-pool="pool --rpcserver=terminal.mydomain.com:8443 --tlscertpath=~/.lit/letsencrypt/terminal.mydomain.com --macaroonpath=~/.loop/testnet/loop.macaroon"
```shell
alias lit-pool="pool --rpcserver=terminal.mydomain.com:8443 --tlscertpath=~/.lit/letsencrypt/terminal.mydomain.com --macaroonpath=~/.loop/testnet/loop.macaroon"
```
### Example `frcli` command
@ -138,8 +139,8 @@ alias lit-pool="pool --rpcserver=terminal.mydomain.com:8443 --tlscertpath=~/.lit
Faraday's command line tool follows the same pattern as loop. We also have to specify the
**LetEncrypt** `host:port` and TLS certificate but use `faraday`'s macaroon:
```shell script
$ frcli \
```shell
frcli \
--rpcserver=terminal.mydomain.com:8443 \
--tlscertpath=~/.lit/letsencrypt/terminal.mydomain.com \
--macaroonpath=~/.faraday/testnet/faraday.macaroon \
@ -149,6 +150,6 @@ $ frcli \
You can easily create an alias for this by adding the following line to your `~/.bashrc`
file:
```shell script
alias lit-frcli="frcli --rpcserver=terminal.mydomain.com:8443 --tlscertpath=~/.lit/letsencrypt/terminal.mydomain.com --macaroonpath=~/.faraday/testnet/faraday.macaroon"
```shell
alias lit-frcli="frcli --rpcserver=terminal.mydomain.com:8443 --tlscertpath=~/.lit/letsencrypt/terminal.mydomain.com --macaroonpath=~/.faraday/testnet/faraday.macaroon"
```

View file

@ -1,6 +1,6 @@
## Run Lightning Terminal with a remote LND instance
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
```
@ -21,15 +21,15 @@ Create a `lit.conf` file. The default location LiT will look for the configurati
- Windows: `~/AppData/Roaming/Lit/lit.conf`
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.macaroonpath=/some/folder/with/lnd/data/admin.macaroon
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.

View file

@ -22,7 +22,7 @@ Client-side logs are disabled by default in production builds. Logging can be tu
adding a couple keys to your browser's `localStorage`. Simply run these two JS statements
in you browser's DevTools console then refresh the page:
```
```javascript
localStorage.setItem('debug', '*'); localStorage.setItem('debug-level', 'debug');
```