Skip to Content
Getting StartedQuickstart

Quickstart

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

Install

npm i -g seqdesk && seqdesk

Native installations automatically update in the background to keep you on the latest stable version.

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:

curl -fsSL https://seqdesk.com/install.sh | bash -s -- -y --dir /opt/seqdesk # Same through npm launcher seqdesk -y --dir /opt/seqdesk

First Login

Open SeqDesk

Navigate to http://localhost:3000 (or the port you configured). The setup wizard runs automatically — it creates the database 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