update docs so master is runnable.

.env.example

@@ -8,20 +8,31 @@ PORT=5000
 LNBITS_SITE_TITLE=LNbits
 LNBITS_ALLOWED_USERS=""
 LNBITS_DEFAULT_WALLET_NAME="LNbits wallet"
-LNBITS_DATA_FOLDER="/your_custom_data_folder" #IMPORTANT! i.e. "/home/satoshi/lnbits/lnbits/data"
+LNBITS_DATA_FOLDER="."
 LNBITS_DISABLED_EXTENSIONS="amilk"
 LNBITS_FORCE_HTTPS=true
 LNBITS_SERVICE_FEE="0.0"
 
-# Choose from LNPayWallet, OpenNodeWallet, LntxbotWallet, LndWallet (gRPC), LndRestWallet, CLightningWallet, LnbitsWallet
+# Choose from LNPayWallet, OpenNodeWallet, LntxbotWallet, LndWallet (gRPC),
-LNBITS_BACKEND_WALLET_CLASS=LntxbotWallet
+#             LndRestWallet, CLightningWallet, LnbitsWallet, SparkWallet
+LNBITS_BACKEND_WALLET_CLASS=VoidWallet
+# VoidWallet is just a fallback that works without any actual Lightning capabilities,
+# just so you can see the UI before dealing with this file.
 
+# Set one of these blocks depending on the wallet kind you chose above:
+# SparkWallet
+SPARK_URL=http://localhost:9737/rpc
+SPARK_TOKEN=myaccesstoken
+
+# CLightningWallet
 CLIGHTNING_RPC="/home/bob/.lightning/bitcoin/lightning-rpc"
 
+# LnbitsWallet
 LNBITS_ENDPOINT=127.0.0.1:5000
 LNBITS_INVOICE_MACAROON=LNBITS_INVOICE_MACAROON
 LNBITS_ADMIN_MACAROON=LNBITS_ADMIN_MACAROON
 
+# LndWallet
 LND_GRPC_ENDPOINT=127.0.0.1
 LND_GRPC_PORT=11009
 LND_CERT="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/tls.cert"
@@ -29,22 +40,26 @@ LND_ADMIN_MACAROON="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chai
 LND_INVOICE_MACAROON="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/invoice.macaroon"
 LND_READ_MACAROON="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/read.macaroon"
 
+# LndRestWallet
 LND_REST_ENDPOINT=https://localhost:8080/
 LND_REST_CERT="/home/bob/.config/Zap/lnd/bitcoin/mainnet/wallet-1/data/chain/bitcoin/mainnet/tls.cert"
 LND_REST_ADMIN_MACAROON="HEXSTRING"
 LND_REST_INVOICE_MACAROON="HEXSTRING"
 LND_REST_READ_MACAROON="HEXSTRING"
 
+# LNPayWallet
 LNPAY_API_ENDPOINT=https://lnpay.co/v1/
 LNPAY_API_KEY=LNPAY_API_KEY
 LNPAY_ADMIN_KEY=LNPAY_ADMIN_KEY
 LNPAY_INVOICE_KEY=LNPAY_INVOICE_KEY
 LNPAY_READ_KEY=LNPAY_READ_KEY
 
+# LntxbotWallet
 LNTXBOT_API_ENDPOINT=https://lntxbot.bigsun.xyz/
 LNTXBOT_ADMIN_KEY=LNTXBOT_ADMIN_KEY
 LNTXBOT_INVOICE_KEY=LNTXBOT_INVOICE_KEY
 
+# OpenNodeWallet
 OPENNODE_API_ENDPOINT=https://api.opennode.com/
 OPENNODE_ADMIN_KEY=OPENNODE_ADMIN_KEY
 OPENNODE_INVOICE_KEY=OPENNODE_INVOICE_KEY

Procfile

@@ -1 +1 @@
-web: hypercorn --bind 0.0.0.0:5000 lnbits.app:create_app()
+web: hypercorn --bind 0.0.0.0:5000 'lnbits.app:create_app()'

docs/devs/installation.md

@@ -29,7 +29,7 @@ If you wish to use a version of Python higher than 3.7:
 $ pipenv --python 3.8 install --dev
 ```
 
-You will need to set the variables in `.env.example`, and rename the file to `.env`.
+You will need to copy `.env.example` to `.env`, then set variables there.
 
 ![Files](https://i.imgur.com/ri2zOe8.png)
 

docs/guide/installation.md

@@ -11,23 +11,25 @@ Basic installation
 Download this repo and install the dependencies:
 
 ```sh
-$ git clone https://github.com/lnbits/lnbits.git
+git clone https://github.com/lnbits/lnbits.git
-$ python3 -m venv .venv
+cd lnbits/
-$ source ./.venv/bin/activate
+python3 -m venv venv
-(.venv) $ pip install -r requirements.txt
+./venv/bin/pip install -r requirements.txt
+cp .env.example .env
+./venv/bin/quart assets
+./venv/bin/quart migrate
+./venv/bin/hypercorn --bind 0.0.0.0:5000 'lnbits.app:create_app()'
 ```
 
-You will need to set the variables in `.env.example`, and rename the file to `.env`.
+No you can visit your LNbits at http://localhost:5000/.
 
-Run the server:
+Now modify the `.env` file with any settings you prefer and add a proper [funding source](./wallets.md) by modifying the value of `LNBITS_BACKEND_WALLET_CLASS` and providing the extra information and credentials related to the chosen funding source.
 
-```sh
+Then you can run restart it and it will be using the new settings.
-(.venv) $ python -m lnbits
-```
 
-You might also need to install additional packages, depending on the [backend wallet](./wallets.md) you use.
+You might also need to install additional packages, depending on the chosen backend.
 E.g. when you want to use LND you have to run:
 
 ```sh
-(.venv) $ pip install lnd-grpc
+./venv/bin/pip install lnd-grpc
 ```