Skip to content

Commit a2cfa8a

Browse files
authored
Merge pull request #14 from lnbits/deploy
install script
2 parents 88f1291 + b763ef2 commit a2cfa8a

3 files changed

Lines changed: 57 additions & 9 deletions

File tree

docs/.vitepress/config.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,7 @@ export default withMermaid(defineConfig({
195195
collapsed: false,
196196
items: [
197197
{ text: 'Choose a Method', link: '/guide/installation/' },
198+
{ text: 'Install Script', link: '/guide/installation/install-script' },
198199
{ text: 'uv', link: '/guide/installation/uv' },
199200
{ text: 'Poetry', link: '/guide/installation/poetry' },
200201
{ text: 'Docker', link: '/guide/installation/docker' },
Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Install Script
2+
3+
> One command to install LNbits on Debian/Ubuntu. The script handles system dependencies, cloning, virtual environment, and configuration.
4+
5+
## Requirements
6+
7+
- Debian or Ubuntu (tested on 22.04+)
8+
- Root or sudo access
9+
10+
## Install
11+
12+
```bash
13+
wget https://raw.githubusercontent.com/lnbits/lnbits/main/lnbits.sh && chmod +x lnbits.sh && ./lnbits.sh
14+
```
15+
16+
The script will:
17+
18+
1. Install system dependencies (Python, build tools, etc.)
19+
2. Clone the LNbits repository
20+
3. Set up a virtual environment with uv
21+
4. Configure the `.env` file
22+
5. Start LNbits
23+
24+
After installation, use `./lnbits.sh` to run LNbits again, or for more control:
25+
26+
```bash
27+
cd lnbits && uv run lnbits
28+
```
29+
30+
## Updating
31+
32+
```bash
33+
cd lnbits
34+
git pull --rebase
35+
uv sync --all-extras
36+
```
37+
38+
After updating, use **Admin UI → Extensions → "Update All"** to update extensions.
39+
40+
## Next steps
41+
42+
- [First Setup](/guide/installation/first-setup) - configure Super User and wallet backend
43+
- [Configuration](/guide/core/environment) - customize your instance
44+
- [Funding sources](/guide/wallets/) - connect a Lightning backend
45+
- [Reverse proxy](/guide/installation/reverse-proxy) - set up HTTPS
46+
- [Process manager](/guide/installation/process-manager) - run LNbits as a service
47+
48+
## Related Pages
49+
50+
- [Installation Overview](/guide/installation/) - all installation methods
51+
- [Install with uv](/guide/installation/uv) - manual uv setup
52+
- [Install with Poetry](/guide/installation/poetry) - alternative source install
53+
- [Updating LNbits](/guide/installation/updating) - keep LNbits up to date

docs/guide/installation/uv.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,15 +66,9 @@ lnbits-cli migrate
6666
lnbits-cli superuser
6767
```
6868

69-
## Install script (Debian/Ubuntu)
70-
71-
The official one-line install script handles everything: system dependencies, cloning, venv setup, and configuration.
72-
73-
```bash
74-
wget https://raw.githubusercontent.com/lnbits/lnbits/main/lnbits.sh && chmod +x lnbits.sh && ./lnbits.sh
75-
```
76-
77-
After installation, use `./lnbits.sh` to run, or for more control: `cd lnbits && uv run lnbits`.
69+
::: tip Want a one-command install?
70+
The [install script](/guide/installation/install-script) handles everything automatically on Debian/Ubuntu.
71+
:::
7872

7973
## Updating
8074

0 commit comments

Comments
 (0)