Changeset 6d3e2c1 in Klonkt


Ignore:
Timestamp:
06/23/2026 06:42:11 PM (3 months ago)
Author:
Robin Genis <roboburr@…>
Branches:
main
Children:
a301d7a
Parents:
d774679
Message:

docs: lead with the one-command VPS installer (recommended), Docker second

Tested end-to-end on a fresh Ubuntu (systemd container): boots + serves + updates.
Use the short klonkt.com/install.sh URL.

Co-Authored-By: Claude <noreply@…>

File:
1 edited

Legend:

Unmodified
Added
Removed
  • README.md

    rd774679 r6d3e2c1  
    3232creates itself on first start.
    3333
    34 ### Option A — Docker (recommended)
     34### Option A — One-command VPS installer (recommended)
     35
     36The simplest way on a fresh Debian/Ubuntu VPS. One command installs Node 20,
     37Caddy (automatic HTTPS) and a systemd service, and is coexistence-safe (won't
     38touch an existing Node/web server):
     39
     40```bash
     41curl -fsSL https://klonkt.com/install.sh | sudo bash -s -- --domain yourdomain.com
     42```
     43
     44Then open your domain and finish setup in the browser. Update later with `klonkt-update`.
     45
     46### Option B — Docker
    3547
    3648Node, ffmpeg and cwebp are inside the image; you only need Docker.
     
    4456Data (database + media) stays in the `klonkt-data` volume, even across updates.
    4557Updating: `git pull && docker compose up -d --build`.
    46 
    47 ### Option B — VPS installer (Debian/Ubuntu)
    48 
    49 One command: installs Node 20, Caddy (automatic HTTPS) and a systemd service.
    50 Coexistence-safe (won't touch an existing Node/web server).
    51 
    52 ```bash
    53 curl -fsSL https://raw.githubusercontent.com/roboburr/klonkt/main/scripts/install.sh \
    54   | sudo bash -s -- --domain yourdomain.com
    55 ```
    56 
    57 After that you can update with `klonkt-update`.
    5858
    5959### Option C — bare Node (20+)
Note: See TracChangeset for help on using the changeset viewer.