Feat: Creates .AppImage a̶n̶d̶ .d̶m̶g̶ on release (#2920)

This commit is contained in:
Arc 2025-02-07 09:17:55 +00:00 committed by GitHub
parent 53b00c6d41
commit 0efb52664e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 175 additions and 72 deletions

View file

@ -6,11 +6,23 @@ nav_order: 2
# Basic installation
The following sections explain how to install LNbits using varions package managers: `poetry`, `nix`, `Docker` and `Fly.io`.
Note that by default LNbits uses SQLite as its database, which is simple and effective but you can configure it to use PostgreSQL instead which is also described in a section below.
## Option 1 (recommended): Poetry
## Option 1: AppImage (LInux)
### AppImage (Linux)
Go to [releases](https://github.com/lnbits/lnbits/releases) and pull latest AppImage, or:
```sh
wget $(curl -s https://api.github.com/repos/lnbits/lnbits/releases/latest | jq -r '.assets[] | select(.name | endswith(".AppImage")) | .browser_download_url') -O LNbits-latest.AppImage
chmod +x LNbits-latest.AppImage
./LNbits-latest.AppImage --host 0.0.0.0
```
LNbits will create a folder for db and extension files in the folder the AppImage runs from.
## Option 2: Poetry (recommended for developers)
It is recommended to use the latest version of Poetry. Make sure you have Python version `3.12` installed.
@ -71,18 +83,6 @@ poetry install --only main
# Start LNbits with `poetry run lnbits`
```
## Option 2: Install script (on Debian/Ubuntu)
```sh
wget https://raw.githubusercontent.com/lnbits/lnbits/main/lnbits.sh &&
chmod +x lnbits.sh &&
./lnbits.sh
```
Now visit `0.0.0.0:5000` to make a super-user account.
`export PATH="/home/$USER/.local/bin:$PATH"` then `./lnbits.sh` can be used to run, but for more control `cd lnbits` and use `poetry run lnbits` (see previous option).
## Option 3: Nix
```sh