highperfocused/lnbits
1
0
Fork 0
mirror of https://github.com/lnbits/lnbits.git synced 2025-12-04 17:51:07 +01:00
Code Issues Packages Projects Releases Wiki Activity

update docs so master is runnable.

Browse Source
This commit is contained in:
fiatjaf
2020-10-02 14:53:55 -03:00
parent 08b2ce5c05
commit e2f6c20e3b
4 changed files with 33 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/guide/installation.md
View File

@@ -11,23 +11,25 @@ Basic installation
Download this repo and install the dependencies:
```sh
$ git clone https://github.com/lnbits/lnbits.git
$ python3 -m venv .venv
$ source ./.venv/bin/activate
(.venv) $ pip install -r requirements.txt
git clone https://github.com/lnbits/lnbits.git
cd lnbits/
python3 -m venv venv
./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
(.venv) $ python -m lnbits
```
Then you can run restart it and it will be using the new settings.
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
```