---

English · Español · Français · Deutsch · 中文 · العربية · Português (Brasil)

🔗 Live Demo — see the public page in action.

🔐 Demo Dashboard — see the dashboard with all features (read-only).

✨ Features

• 🔗 Link Management — Add, reorder, and customize unlimited links with drag-and-drop
• 🌐 Multi-Page Support — Create unlimited pages, each with its own slug, theme, links, analytics, SEO, and QR code
• 🎨 Auto-Favicon Links — Links automatically show the target site's favicon — no manual icon uploads needed
• 📥 Migration Wizard — Import existing links and social profiles from Linktree, Bento, Hopp.bio, LittleLink, or any HTML/JSON export
• 🖼️ Link Thumbnails — Add images to your links for visual preview cards
• 🎵 Embed Widgets — Embed YouTube, Spotify, SoundCloud, Vimeo, or Bandcamp directly on your page
• ⏰ Link Scheduling — Schedule links to appear/disappear automatically with date/time controls
• 🏷️ Custom Redirect Slugs — Give any link a stable, shareable /go/your-name URL that survives delete-and-recreate. Reserved names and pure numbers are blocked so app routes can never be shadowed; a deactivated link with a slug redirects visitors to your public page instead of a 404
• 📊 Privacy-Respecting Analytics — Views, clicks, referrers, device type. Cookieless by design. Visitor IPs are hashed with a daily-rotating salt, never stored. Data older than 90 days is pruned automatically by default (Settings → Data; set 0 to keep everything).
• 📈 External Analytics — Inject Plausible, Umami, Matomo, or Google Analytics with one paste
• 🔔 Update Notifications — Dashboard banner notifies you when a new version is available (no phone-home, no auto-update)
• 🎨 Themes — 11 built-in presets (Aurora, Glassmorphism, Neon Cyberpunk, Editorial Paper, Terminal Mono, Pastel Soft, Brutalist, Retro Sunset, Minimal Light, 8-Bit Retro, Frutiger Aero) + full customizer with CSS token system (colors, 15 fonts + custom font upload, 8 background types, 8 card styles, layout controls, effects) + theme duplicate/import/export
• ✏️ Custom CSS — Fine-tune your page with raw CSS injection
• 📧 Email Capture — Collect subscriber emails on your public page, export to CSV
• 📱 Mobile-First — Gorgeous on every screen. Loads in under 300ms. Zero client-side JS bundles.
• 🎯 QR Codes — Auto-generated for your page. Download as SVG or PNG. Customize colors, embed your avatar or favicon in the center, export up to 1024 px for print.
• 🔒 Self-Hosted — Your data, your server. No third-party trackers. No ads. No subscription.
• 🐳 One-Command Deploy — Docker compose and you're live

🚀 Quick Start

One command — zero config — live in 30 seconds:

curl -fsSL https://linkbreeze.omnirise.dev/install.sh | bash

or pull the multi-arch image directly:

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

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.

curl -fsSL https://linkbreeze.omnirise.dev/install.sh -o install.sh
less install.sh
bash install.sh

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

Prefer a different method? Expand one below:

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

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

services:
  linkbreeze:
    image: docker.io/omnirise/linkbreeze:latest
    ports:
      - "3000:3000"
    volumes:
      - linkbreeze-data:/app/data
    restart: unless-stopped
volumes:
  linkbreeze-data:

docker compose up -d

git clone https://github.com/Manak-hash/LinkBreeze.git
cd LinkBreeze
docker compose up -d --build

services:
  linkbreeze:
    image: docker.io/omnirise/linkbreeze:latest
    ports:
      - "3000:3000"
    volumes:
      - linkbreeze-data:/app/data
    restart: unless-stopped
volumes:
  linkbreeze-data:

podman run -d --name linkbreeze --restart unless-stopped -p 3000:3000 -v linkbreeze-data:/app/data docker.io/omnirise/linkbreeze:latest

services:
  linkbreeze:
    image: docker.io/omnirise/linkbreeze:latest
    ports:
      - "3000:3000"
    volumes:
      - linkbreeze-data:/app/data
    restart: unless-stopped
volumes:
  linkbreeze-data:

git clone https://github.com/Manak-hash/LinkBreeze.git
cd LinkBreeze
npm install
cp .env.example .env
Edit .env to set your SECRET_KEY and DATABASE_PATH if needed

npm run db:migrate
npm run dev

LinkBreeze runs on your server. Once deployed, your page is accessible to anyone at https://your-domain.com/your-slug. Here's how to get it online:

1. Point your domain's A record to your server IP
2. Expose port 3000 or add a reverse proxy
3. Done — your page is live at https://your-domain.com/your-slug

For production setups — reverse proxies with automatic TLS, zero-trust tunnels, Kubernetes, scheduled backups — see the examples/ directory. Each example is a single, self-contained file with a header comment explaining when to use it.

links.example.com {
    reverse_proxy localhost:3000
}

server {
    server_name links.example.com;
    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

cloudflared tunnel --url http://localhost:3000

For a complete Docker Compose setup with Cloudflare Tunnel, see examples/docker-compose.cloudflare-tunnel.yml.

📸 Screenshots

Click to expand

Public Page	Admin Dashboard
Links	Profile
Theme	Live Preview Pane
Settings [General]	Settings [Appearance]
Settings [Security]	Settings [Data]

🆚 Comparison

| Feature | Linktree | LinkStack | LittleLink | Shako | LinkBreeze | |---------|----------|-----------|------------|-------|----------------| | Price | $15/mo | Free | Free | Free | Free | | Admin Panel | ✅ | Slow | ❌ | ❌ | ✅ Fast | | Multi-Page | ✅ (paid) | ❌ | ❌ | ❌ | ✅ | | Auto-Favicon Links | ❌ | ❌ | ❌ | ❌ | ✅ | | Migration Wizard | ❌ | ❌ | ❌ | ❌ | ✅ | | Database | Theirs | MySQL | None | None | SQLite | | Built-in Analytics | Paid | Basic | ❌ | ❌ | ✅ Full | | External Analytics | ✅ | ✅ | ❌ | ❌ | ✅ | | Email Capture | Paid | ❌ | ❌ | ❌ | ✅ | | Embed Widgets | Paid | ❌ | ❌ | ❌ | ✅ | | Link Thumbnails | ✅ | ❌ | ❌ | ❌ | ✅ | | QR Codes | ✅ | ✅ | ❌ | ❌ | ✅ | | Link Scheduling | Paid | ❌ | ❌ | ❌ | ✅ | | Themes | Paid | Limited | CSS only | Config | ✅ Full Token System + Import/Export | | Custom CSS | ❌ | ❌ | ✅ | ❌ | ✅ | | Self-Hosted | ❌ | ✅ | ✅ | ✅ | ✅ | | Language | Closed | PHP | HTML | Astro | TypeScript | | Docker Deploy | N/A | Complex | Simple | Simple | One command | | Page Load | ~2-3s | ~1-2s | Fast | Fast | <300ms | | License | Closed | AGPL | MIT | GPL | MIT |

🛠️ Tech Stack

| Layer | Technology | |-------|-----------| | Framework | Next.js 16 (App Router, Server Components, ISR) | | Database | SQLite via better-sqlite3 (WAL mode) | | ORM | Drizzle ORM (type-safe, zero overhead) | | Auth | Cookie-based HMAC sessions, Argon2id (legacy bcrypt hashes upgrade on login) | | UI | shadcn/ui + Tailwind CSS 4 | | Drag & Drop | dnd-kit | | Charts | Recharts | | QR Codes | qrcode (server-side SVG/PNG) | | Validation | Zod | | Icons | Lucide + custom social SVGs |

📖 Documentation

• Contributing Guide
• Security Policy
• Changelog
• Troubleshooting
• Architecture Decisions
• Configuration Reference

🛳️ Repositories & Registry

| Where | URL | |---|---| | Source (GitLab, canonical public mirror) | gitlab.com/omnirise00/linkbreeze | | Source (GitHub) | github.com/Manak-hash/LinkBreeze | | Container image | docker.io/omnirise/linkbreeze (Docker Hub) |

All configuration is via environment variables (.env). .env.example is the canonical reference — copy it (cp .env.example .env) and it documents every variable, including the wallet-credential blocks with their caveats inline:

| Variable | Default | Description | |----------|---------|-------------| | PORT | 3000 | Server port | | DATABASE_PATH | ./data/linkbreeze.db | SQLite database file path | | SECRET_KEY | Auto-generated | HMAC signing key for sessions | | EXTRA_SCRIPT_SRC | _(empty)_ | Space-separated analytics domains for CSP (e.g. plausible.io umami.is) | | GOOGLE_WALLET_ISSUER_ID | _(empty)_ | Enables "Add to Google Wallet" buttons on public pages. Numeric issuer ID from the Google Pay & Wallet Console. | | GOOGLE_WALLET_SERVICE_ACCOUNT_JSON | _(empty)_ | Full service-account JSON (client_email + private_key) authorized for the Wallet API. | | APPLE_WALLET_CERT_PEM | _(empty)_ | Enables "Add to Apple Wallet" buttons. Pass Type ID signing certificate (PEM). | | APPLE_WALLET_KEY_PEM | _(empty)_ | Private key matching the signing certificate (PEM). | | APPLE_WALLET_KEY_PASSPHRASE | _(empty)_ | Passphrase for the signing key, if encrypted. | | APPLE_WALLET_WWDR_PEM | _(empty)_ | Apple WWDR intermediate certificate (PEM). | | APPLE_WALLET_TEAM_ID | _(empty)_ | Your 10-character Apple Team ID. | | APPLE_WALLET_PASS_TYPE_ID | _(empty)_ | Your Pass Type ID (must start with pass.). |

The built-in analytics covers views, clicks, referrers, and device type with no setup needed. If you want to add a third-party analytics provider, paste your Chat with me