Skip to Content
InstallationQuickstart

Quickstart

Use the npm launcher for guided setup when Node.js/npm is already available. Before installing on a shared server, review the installation prerequisites, especially the PostgreSQL role/database requirement.

npm i -g seqdesk seqdesk

Under the hood, the launcher downloads https://seqdesk.com/install.sh over HTTPS and executes it with bash. The public command should still be the npm launcher; the direct shell script is an advanced fallback for environments where npm cannot be used. The launcher pins SEQDESK_VERSION to the npm package version (unless you set it yourself), so seqdesk@1.1.82 installs SeqDesk 1.1.82 — upgrade the launcher (npm i -g seqdesk@latest) before installing a newer release. The npm tarball also ships a manual install checklist  useful for end-to-end verification on a fresh host.

Installer output and behavior come from the deployed SeqDesk.com/public/install.sh file. Changes made in the SeqDesk app repository are not visible to the npm launcher or fallback curl command until that public installer file has been updated and SeqDesk.com has been deployed.

Install location depends on where you run the command. The default target is ./seqdesk relative to your current directory.

For predictable installs, set an explicit absolute path with --dir:

seqdesk -y --dir /opt/seqdesk

Advanced fallback when npm is unavailable:

curl -fsSL https://seqdesk.com/install.sh | bash

What this gives you

  • Core SeqDesk platform on your own infrastructure
  • Interactive prompts for runtime and pipeline settings
  • A baseline setup you can later convert into unattended automation

PostgreSQL setup

SeqDesk needs a PostgreSQL database before migrations can complete. If the installer runs as a sudo-capable account, it can prepare local PostgreSQL automatically. On locked-down servers, ask the administrator to prepare the database first, then provide the resulting DATABASE_URL during install or in your hosted profile/config file.

Verify the install

After the installer finishes, run seqdesk doctor against the install directory to confirm the layout is intact, the database is reachable, and (if the app is running) the HTTP probes pass:

seqdesk doctor --dir /opt/seqdesk

From source

For development checkouts or CI, use the source installer instead of the distribution one:

bash scripts/install.sh -y --dir ./seqdesk-source

The source installer accepts most of the same flags as the distribution installer plus --branch <branch> to pin the Git ref. It does not support --profile, --profile-code, --reconfigure, or --reseed-db. Override the upstream repository with SEQDESK_REPO, the branch with SEQDESK_BRANCH.