Installation

Install SeqDesk with a guided flow first, then move to unattended deployment as your environment standards solidify.

Use the npm launcher (npm i -g seqdesk && seqdesk) as the supported install entry point. It downloads and runs the public shell installer internally, so operators normally do not need to call install.sh directly.

Most people

You need Node.js 18+ and a PostgreSQL database. Then:


npm i -g seqdesk && seqdesk

The guided installer checks prerequisites first, sets up a local PostgreSQL for you if you can use sudo (or accepts your own connection string via --database-url), applies migrations, and prints the login URL when it finishes. For the full walkthrough see Quickstart; for the PostgreSQL options (managed, local-with-sudo, locked-down) see Prerequisites.

Compare installation methods

Every method boots the same SeqDesk app — pick one by your scenario. For most users, the npm launcher is the recommended path.

Method	Command	Best for	Learn more
npm launcher (recommended)	`npm i -g seqdesk` then `seqdesk`	Almost everyone — supported, CI-tested install + upgrade	Quickstart
One-line installer	`curl -fsSL https://seqdesk.com/install.sh \| bash`	Fallback when npm is unavailable	Quickstart
macOS (Homebrew)	`npm i -g seqdesk && seqdesk`	Local Mac workstation / dev installs	macOS
Unattended	`seqdesk -y --config ./infrastructure-setup.json`	Fleet or scripted deployments; update in place with `--reconfigure`	Unattended · Infrastructure JSON
Vercel + Neon demo	Hosted deploy recipe (not a general operator install)	A public demo / sandbox instance	Vercel + Neon demo
From source	`bash scripts/install.sh`	Developers / CI building a specific branch	Quickstart

PrerequisitesNode.js, PostgreSQL, filesystem, and optional pipeline requirements.QuickstartFastest path for first deployment.macOS installInstall a local instance on macOS with Homebrew PostgreSQL.Infrastructure JSONComplete field-by-field setup reference.Unattended + ReconfigureAutomate installs and update existing nodes safely.seqdesk doctorRun health checks against an installed SeqDesk instance.Vercel + Neon DemoDeploy the hosted demo with managed PostgreSQL.

Recommended Path

Check prerequisites

Confirm Node.js/npm, PostgreSQL access, and writable install/data directories.

Guided bootstrap

Run the installer interactively using the quickstart command.

For a local macOS setup, see the macOS install guide, which uses Homebrew PostgreSQL and the npm launcher.

Formalize config

Create and review infrastructure-setup.json, then store it with your deployment automation.

Repeatable operations

Use unattended mode for new hosts and --reconfigure for existing installations.