• 🔗 Link Management - Add, reorder and customize unlimited links with drag-and-drop

• 🌐 Auto-Favicon Links - Links automatically show the target site's favicon, no icon uploads needed

• 🖼️ Link Thumbnails - Add images to your links for visual preview cards

• ⏰ Link Scheduling - Schedule links to appear or disappear automatically with date/time controls

• 🏷️ Custom Redirect Slugs - Stable, shareable /go/your-name short links that survive delete-and-recreate

• 📈 External Analytics - Inject Plausible, Umami, Matomo or Google Analytics with one paste

• 🖼️ Social Preview (OG) Images - Share cards auto-rendered from your page's theme, or upload your own with fit, position and zoom control

• ✏️ Custom CSS - Fine-tune your page with raw CSS injection

• 📧 Email Capture - Collect subscriber emails on your public page, export to CSV

• 🔔 Update Notifications - Dashboard banner when a new version is available. No phone-home, no auto-update

• 🔑 Fast Admin Panel - Everything above from one clean, instant dashboard

• 🌐 Custom Domains - Bind your own domains to pages; exclusive or hub scope, automatic canonical redirects, strict admin host lock

• ⏰ Scheduled Backups - Daily/weekly/monthly app-internal backups with retention and one-click restore, no cron required

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

No Node.js, no npm, no config files. Multi-arch images: linux/amd64 and linux/arm64 (Raspberry Pi 3/4/5, Apple Silicon, ARM VPS).

Linux / macOS / Windows CMD:

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

Windows PowerShell - use backticks for line breaks:

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

Database migrations run automatically on container startup.

Create a docker-compose.yml:

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

Upgrade: docker compose pull && docker compose up -d · Logs: docker compose logs -f linkbreeze

Prefer building from source? git clone https://github.com/OmniRise/LinkBreeze.git && cd LinkBreeze && docker compose up -d --build

1. + New Resource → Docker Compose Empty
2. Paste the compose file from the section above
3. Set a domain (e.g. links.yourdomain.com) - Coolify handles Let's Encrypt automatically
4. Click Deploy

Container Manager (DSM 7.2+):

1. Pull the image docker.io/omnirise/linkbreeze:latest (Image → Add, if not found)
2. Create a container: name linkbreeze, port 3000 → 3000, volume /docker/linkbreeze/data → /app/data, restart policy Unless stopped
3. Click Done - live at http://<nas-ip>:3000

Data persists in the volume across image updates.

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

Permission errors on the volume? Run podman volume create linkbreeze-data first. The install script at the top detects Podman automatically.

1. Stacks → Add stack, name it linkbreeze
2. Paste the compose file from the Docker Compose section above
3. Click Deploy the stack

Updates: Stacks → linkbreeze → Editor → Pull and redeploy.

Requires Node.js 18+.

git clone https://github.com/OmniRise/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

For production: npm run build && npm start

Once deployed, your page is at https://your-domain.com/your-slug.

1. Point your domain's A record to your server IP
2. Expose port 3000 or put a reverse proxy in front
3. Done

Ready-made compose files live in examples/ - one self-contained file per scenario:

Caddy (recommended - auto HTTPS):

links.example.com {
    reverse_proxy localhost:3000
}

Nginx:

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;
    }
}

Cloudflare Tunnel (no open ports, no domain purchase needed):

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

Every public page renders a share block with a "Save contact" button (universal vCard, always on). The wallet buttons light up automatically when the credentials above are configured. Google Wallet: free issuer account, but passes only save for whitelisted test users until Google grants production access. Apple Wallet: requires a paid Apple Developer account and installs from Safari only. Passes are static snapshots - the QR on the pass always opens the live page. Settings → Integration shows per-wallet credential status and warns when the Apple signing certificate is about to expire.

The theme engine is a CSS custom property (--lb-*) token system - every color, radius, shadow and font on the public page is a token.

• Background - 8 types (solid, gradient, radial, mesh, aurora, animated gradient, image, pattern) with angle, overlay and opacity controls
• Colors - accent, secondary, text, muted text, card background, card border (hex or rgba)
• Typography - 15 curated Google Fonts, font scale, weight, letter spacing - or upload your own woff2/woff (max 2 MB). Uploaded fonts are served same-origin, embedded in theme exports and carried through backups
• Card style - 7 link styles (pill, rounded, sharp, glass, outline, neon, pixel), hover effects, button size, corner radius, border width, shadow strength
• Layout - container width, alignment (left/center/right), density (compact/normal/relaxed)
• Effects - glow with custom color, glass blur, noise texture, reveal animation
• Duplicate / import / export - clone any theme as an editable copy and share it as JSON