Skip to Content
Getting StartedQuickstart

Quickstart

Get SeqDesk running on your machine and create your first sequencing order.

Install

NPM Launcher
npm i -g seqdesk && seqdesk

This is the supported install path. The launcher downloads and runs the public installer internally, so most users do not need to call the shell script directly.

The npm command installs the seqdesk launcher first. The launcher downloads and runs the public installer internally, so the direct curl command is only an advanced fallback.

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

First Login

Open SeqDesk

Navigate to http://localhost:3000 (or the port you configured). The setup wizard runs automatically when the configured PostgreSQL database is reachable. It applies the schema and seeds default accounts.

Sign in

Use the default admin credentials:

EmailPasswordRole
admin@example.comadminFacility Admin

Change this password immediately after first login.

Run the setup checklist

As admin, configure the essentials:

  • Site name and branding — Admin → Settings
  • Departments — Admin → Departments
  • Sequencing technologies — Admin → Sequencing Technology
  • Data storage path — Admin → Data Compute

Create Your First Order

Switch to researcher role or register a new account

Navigate to /register to create a researcher account, or use the default researcher credentials (user@example.com / user).

Create an order

From the Orders page, start a new order. The wizard walks you through:

  1. Order Details — name and sample count
  2. Sequencing Parameters — platform, instrument, library strategy
  3. Samples — organism, title, and any custom metadata
  4. Review & Submit

Check status

Your order appears on the Orders page with status SUBMITTED. The facility admin can now assign files, create studies, and run pipelines.

What’s Next