From e721ae1d127623fbff6ec79e46a199329029bd28 Mon Sep 17 00:00:00 2001 From: Arc <33088785+arcbtc@users.noreply.github.com> Date: Mon, 8 Nov 2021 09:50:11 +0000 Subject: [PATCH 1/6] Update installation.md --- docs/guide/installation.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/guide/installation.md b/docs/guide/installation.md index 728bfc32b..3051176ed 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -9,9 +9,10 @@ nav_order: 2 Download this repo and install the dependencies: ```sh -git clone https://github.com/lnbits/lnbits.git +git clone https://github.com/lnbits/lnbits-legend.git cd lnbits/ # ensure you have virtualenv installed, on debian/ubuntu 'apt install python3-venv' should work +# for now you'll need to `git checkout FastAPI` python3 -m venv venv ./venv/bin/pip install -r requirements.txt cp .env.example .env From 17db309f35363d3b6ca8bbd3dbc2014d671df89f Mon Sep 17 00:00:00 2001 From: Arc <33088785+arcbtc@users.noreply.github.com> Date: Tue, 9 Nov 2021 22:39:20 +0000 Subject: [PATCH 2/6] Update installation.md --- docs/devs/installation.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/devs/installation.md b/docs/devs/installation.md index 013f7be90..394eb7a02 100644 --- a/docs/devs/installation.md +++ b/docs/devs/installation.md @@ -15,6 +15,9 @@ The application uses [Pipenv][pipenv] to manage Python packages. While in development, you will need to install all dependencies: ```sh +$ git clone https://github.com/lnbits/lnbits-legend.git +$ cd lnbits-legend/ +$ # for now you'll need to `git checkout FastAPI` $ pipenv shell $ pipenv install --dev ``` From 3b8920b4364cc8c66c0575a40dec91122abb18d4 Mon Sep 17 00:00:00 2001 From: Arc <33088785+arcbtc@users.noreply.github.com> Date: Tue, 9 Nov 2021 22:40:11 +0000 Subject: [PATCH 3/6] Update installation.md --- docs/devs/installation.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/devs/installation.md b/docs/devs/installation.md index 394eb7a02..7a8dfd6fc 100644 --- a/docs/devs/installation.md +++ b/docs/devs/installation.md @@ -14,13 +14,11 @@ Download the latest stable release https://github.com/lnbits/lnbits/releases The application uses [Pipenv][pipenv] to manage Python packages. While in development, you will need to install all dependencies: -```sh -$ git clone https://github.com/lnbits/lnbits-legend.git -$ cd lnbits-legend/ -$ # for now you'll need to `git checkout FastAPI` -$ pipenv shell -$ pipenv install --dev -``` + git clone https://github.com/lnbits/lnbits-legend.git + cd lnbits-legend/ + # for now you'll need to `git checkout FastAPI` + pipenv shell + pipenv install --dev If any of the modules fails to install, try checking and upgrading your setupTool module. `pip install -U setuptools` From d81559ba2e30b9ebcc128a53dca8286577f3dd71 Mon Sep 17 00:00:00 2001 From: Arc <33088785+arcbtc@users.noreply.github.com> Date: Tue, 9 Nov 2021 22:41:24 +0000 Subject: [PATCH 4/6] Update installation.md --- docs/devs/installation.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/docs/devs/installation.md b/docs/devs/installation.md index 7a8dfd6fc..7d2e7da5b 100644 --- a/docs/devs/installation.md +++ b/docs/devs/installation.md @@ -25,9 +25,7 @@ If any of the modules fails to install, try checking and upgrading your setupToo If you wish to use a version of Python higher than 3.7: -```sh -$ pipenv --python 3.8 install --dev -``` + pipenv --python 3.8 install --dev You will need to copy `.env.example` to `.env`, then set variables there. @@ -43,21 +41,15 @@ Take a look at [Polar][polar] for an excellent way of spinning up a Lightning Ne LNbits uses [Quart][quart] as an application server. Before running the server for the first time, make sure to create the data folder: -```sh -$ mkdir data -``` + mkdir data To then run the server, use: -```sh -$ pipenv run python -m lnbits -``` + pipenv run python -m lnbits **Note**: You'll need to use _https_ for some endpoints and/or extensions. You can use [ngrok](https://ngrok.com/) for that. Follow the installation instructions on the website and when it's all set you can run: -```sh -$ ./nrok http 5000 -``` + ./nrok http 5000 this will give you an _https_ tunnel for the _localhost_, use that URL for navigating to LNBits. From 6b6d300058c4d2dac564c7ea9dd7d777eae322de Mon Sep 17 00:00:00 2001 From: Arc <33088785+arcbtc@users.noreply.github.com> Date: Tue, 9 Nov 2021 22:44:11 +0000 Subject: [PATCH 5/6] Update installation.md --- docs/devs/installation.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/devs/installation.md b/docs/devs/installation.md index 7d2e7da5b..eb55f1200 100644 --- a/docs/devs/installation.md +++ b/docs/devs/installation.md @@ -42,10 +42,11 @@ LNbits uses [Quart][quart] as an application server. Before running the server for the first time, make sure to create the data folder: mkdir data + To then run the server, use: - pipenv run python -m lnbits + pipenv run python -m uvicorn lnbits.__main__:app --reload **Note**: You'll need to use _https_ for some endpoints and/or extensions. You can use [ngrok](https://ngrok.com/) for that. Follow the installation instructions on the website and when it's all set you can run: From 2f9751940e11fba63ce7cec770b22a7e1e19f313 Mon Sep 17 00:00:00 2001 From: Arc <33088785+arcbtc@users.noreply.github.com> Date: Tue, 9 Nov 2021 22:45:45 +0000 Subject: [PATCH 6/6] Update installation.md --- docs/devs/installation.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/devs/installation.md b/docs/devs/installation.md index eb55f1200..21f1003d0 100644 --- a/docs/devs/installation.md +++ b/docs/devs/installation.md @@ -38,11 +38,12 @@ Take a look at [Polar][polar] for an excellent way of spinning up a Lightning Ne ## Running the server -LNbits uses [Quart][quart] as an application server. -Before running the server for the first time, make sure to create the data folder: +LNbits uses [FastAPI][fastapi] as an application server. +Before running the server for the first time, make sure to create the data folder and edit the .env file: mkdir data - + cp .env.example .env + sudo nano .env To then run the server, use: