Quickstart

Get LinkBreeze running in under 30 seconds.

One-Command Install

The fastest way to get LinkBreeze running:

curl -fsSL https://raw.githubusercontent.com/Manak-hash/LinkBreeze/main/scripts/install.sh | bash

The script detects Docker or Podman, pulls the image, starts the container, and optionally sets up a systemd service for auto-start on boot. Want auto-start on boot? Run it with sudo bash instead and answer y when prompted.

Don't like piping to bash?

curl -fsSL https://raw.githubusercontent.com/Manak-hash/LinkBreeze/main/scripts/install.sh -o install.sh
less install.sh
bash install.sh

Then open http://localhost:3000 — the setup wizard takes under 30 seconds.

Docker

No Node.js, no npm, no config files needed:

docker run -d --name linkbreeze --restart unless-stopped -p 3000:3000 -v linkbreeze-data:/app/data ghcr.io/manak-hash/linkbreeze:latest

Database migrations run automatically on container startup — no manual drizzle-kit migrate needed.

Docker Compose

Best if you want to customize ports, add a reverse proxy, or manage updates easily.

Create a docker-compose.yml:

services:
  linkbreeze:
    image: ghcr.io/manak-hash/linkbreeze:latest
    ports:
      - "3000:3000"
    volumes:
      - linkbreeze-data:/app/data
    restart: unless-stopped

volumes:
  linkbreeze-data:
docker compose up -d

Upgrade anytime: docker compose pull && docker compose up -d

First-Run Setup

  1. Open http://localhost:3000 in your browser
  2. The setup wizard will appear automatically on first launch
  3. Create your admin account
  4. Add your first link
  5. Your page is live at http://localhost:3000/your-slug

That's it. You have a fully functional link-in-bio page.

Next Steps

Next
Docker