Manual

Prefer to run LinkBreeze without Docker? You'll need Node.js.

Prerequisites

• Node.js 18+ (Node 22 recommended)
• npm or your preferred package manager

Clone and Build

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

For production:

npm run build
npm start

LinkBreeze runs on port 3000 by default.

Using PM2 (Process Manager)

Keep LinkBreeze running permanently with PM2:

npm install -g pm2
pm2 start npm --name linkbreeze -- start
pm2 save
pm2 startup

Data Directory

The default data directory is ./data/. Override with:

DATA_DIR=/var/lib/linkbreeze npm start

Updating

git pull
npm install
npm run build
pm2 restart linkbreeze