From 4e5b001901a8017676d71aa04e4af635f5645d7b Mon Sep 17 00:00:00 2001 From: Arc <33088785+arcbtc@users.noreply.github.com> Date: Thu, 19 Dec 2024 09:23:49 +0000 Subject: [PATCH] docs: updated install guide (#2846) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Updated install guide * Needed for secp256k1 * added lnbits-cli * heading missing * prettier --------- Co-authored-by: dni ⚡ --- docs/guide/installation.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/docs/guide/installation.md b/docs/guide/installation.md index d71d54ed5..db763bd6a 100644 --- a/docs/guide/installation.md +++ b/docs/guide/installation.md @@ -12,11 +12,15 @@ Note that by default LNbits uses SQLite as its database, which is simple and eff ## Option 1 (recommended): Poetry -It is recommended to use the latest version of Poetry. Make sure you have Python version 3.9 or higher installed. +It is recommended to use the latest version of Poetry. Make sure you have Python version `3.12` installed. -### Verify Python version +### Install Python 3.12 ```sh +sudo add-apt-repository ppa:deadsnakes/ppa +sudo apt update +sudo apt install python3.12 +sudo apt-get install python3.12-dev # ensure correct headers needed for secp256k1 python3 --version ``` @@ -28,16 +32,16 @@ curl -sSL https://install.python-poetry.org | python3 - export PATH="/home/user/.local/bin:$PATH" ``` +### install LNbits + ```sh git clone https://github.com/lnbits/lnbits.git cd lnbits +poetry env use 3.12 git checkout main - poetry install --only main - cp .env.example .env -# set funding source amongst other options -nano .env +# Optional: to set funding source amongst other options via the env `nano .env` ``` #### Running the server @@ -49,9 +53,16 @@ poetry run lnbits # Note that you have to add the line DEBUG=true in your .env file, too. ``` +#### LNbits-cli + +```sh +# A very useful terminal client for getting the supersuer ID, updating extensions, etc +poetry run lnbits-cli --help +``` + #### Updating the server -``` +```sh cd lnbits # Stop LNbits with `ctrl + x` git pull