Administration
Everything in this section is done by a facility admin. SeqDesk has exactly
two roles, and FACILITY_ADMIN is the one that unlocks the admin area, the
whole /api/admin/** surface, visibility of every sequencing order, and the
ability to launch pipelines and register data with ENA. If you are configuring
a SeqDesk instance for other people to use, you are reading the right section.
The mental model
A SeqDesk instance is one facility. There is a single row of global settings
(SiteSettings, id singleton) that everything on these pages writes into, so
“changing a setting” is always instance-wide — there is no per-department or
per-project configuration layer.
Settings reach the running application from three places, and they do not have equal weight:
| Layer | Where it lives | Priority |
|---|---|---|
| Environment variables | SEQDESK_* in the process environment | Highest |
| Config file | settings.json next to the app (legacy: seqdesk.config.json) | Middle |
| Database | Written by the admin screens in this section | Lowest |
This ordering has a consequence that surprises most new operators: if a value
is set in the environment or in settings.json, editing the
matching field in the admin UI saves to the database but has no visible
effect, because the higher layer keeps winning. Check
Info → Configuration sources (/admin/settings)
when a saved setting does not seem to apply. See
Configuration Sources.
Telemetry is the one deliberate exception: there, the stored database choice wins over the config file, so an admin’s explicit opt-in or opt-out is not silently reverted by a deployment default.
Where to start
A brand-new instance is usable in roughly this order. Each step unblocks the next, and the sidebar’s Infrastructure entry shows a red badge until the two required items are done.
- Data Storage — point SeqDesk at the directory holding your FASTQ files. Nothing about sequencing files works until this is set.
- Pipeline Runtime — set the pipeline run directory, and Conda plus SLURM if you intend to run analyses.
- Departments — create them before researchers register, because the registration form only offers departments that already exist and are active.
- Modules — turn features on or off before customising forms, since a disabled module hides its field types everywhere.
- Sequencing Order Form — trim the intake form to what your facility actually needs to know.
- Sequencers — disable the instruments and kits you do not offer.
- ENA Configuration — only if you submit to the European Nucleotide Archive.
- Accounts — invite your co-admins, then decide on department sharing.
Guides in this section
Every admin screen
The sidebar groups admin screens under Users and Settings. The labels below are the ones you see in the sidebar; the headings on the pages themselves sometimes differ, so both are given.
Users
| Sidebar | Path | Page heading | What it does |
|---|---|---|---|
| Researchers | /admin/users | Researchers | Read-only directory of RESEARCHER accounts with search, department and position filters, and per-user sequencing order and study history. See User Management. |
| Departments | /admin/departments | Departments | Create, edit, activate and deactivate departments. See Departments. |
| Support | /messages | Support | The facility side of the ticket inbox. See Support & Messages. |
Settings
| Sidebar | Path | Page heading | What it does |
|---|---|---|---|
| Sequencing Order Form | /admin/form-builder | Sequencing Order Configuration | Intake form for sequencing orders. See Form Builders. |
| Study Forms | /admin/study-form-builder | Study Configuration | Study questionnaire. Replaced by Define Studies when the dynamic-studies module is on. |
| Define Studies | /admin/study-definitions | Define Studies | Per-study questionnaires; only linked when dynamic-studies is enabled. |
| MIxS Checklists | /admin/mixs-checklists | MIxS Checklists | Which MIxS environment checklists researchers may pick. See Study Metadata & MIxS. |
| Modules | /admin/modules | Modules | Enable or disable optional features (table below). See Modules. |
| Sequencers | /admin/sequencing-tech | Sequencing Technologies | Instrument registry. See Sequencing Technologies. |
| MinKNOW Stream | /admin/minknow-stream | MinKNOW Stream | Live Oxford Nanopore ingest: start, stop and pause the stream monitor. |
| Infrastructure | /admin/data-compute | Infrastructure | Readiness hub that links to Data Storage and Pipeline Runtime, plus Import settings.json. |
| Background Workers | /admin/background-workers | Background Workers | Start, stop and pause the stream-monitor and pipeline-monitor daemons and read their recent output. See Background Workers. |
| Accounts | /admin/admin-accounts | Admin Accounts | Admin invites, plus the Department Sharing and User Assembly Downloads toggles. |
| Data Upload | /admin/ena | ENA Configuration | Webin credentials and submission history. See ENA Credentials. |
| Pipelines | /admin/settings/pipelines | Pipelines | Pipeline catalogue: install and sync packages, download reference databases. See Pipelines & Analysis. |
| Notifications | /admin/settings/notifications | Notification Settings | In-app notification panel, hosted email relay, and which events send mail. See Notifications. |
| Info | /admin/settings | Platform Info | Updates, detected tool versions, diagnostics, configuration sources, and the telemetry toggle. |
Three screens have no sidebar entry of their own and are reached from the pages that link to them:
| Path | Page heading | Reached from |
|---|---|---|
/admin/data-storage | Data Storage | Infrastructure, and the Data Storage button on Pipeline Runtime |
/admin/pipeline-runtime | Pipeline Runtime | Infrastructure, and the Pipeline Runtime button on Data Storage |
/admin/sequencing-run-form-builder | Sequencing Run Fields | Info, and the module links on Modules |
Visiting /admin itself shows only a “Select an admin page” placeholder — there
is no admin dashboard.
Modules
Modules (/admin/modules) is the on/off switch for optional features.
Disabling a module hides its field types from every form builder and from the
forms researchers see, regardless of each field’s own visibility setting, so it
is the coarsest control you have.
| Module ID | Name | Default | Effect |
|---|---|---|---|
mixs-metadata | MIxS Metadata | On | MIxS checklist selection and standardised environment fields on studies and samples |
ena-sample-fields | ENA Sample Fields | On | Organism (NCBI taxonomy lookup), Sample Title, Sample Alias |
ai-validation | AI Field Validation | On | Per-field assisted validation with a custom prompt and strictness |
funding-info | External Funding & Grants | Off | Grant agency, grant number, project title, PI |
billing-info | Cost Center & PSP | Off | Cost centre and PSP element with configurable format validation |
dynamic-studies | Dynamic Study Definitions | Off | Multiple study definitions, each with its own questionnaire, instead of one global study form |
account-validation | Account Validation | Off | Restrict registration to listed email domains |
notifications | Email Notifications | Off | Hosted email relay for sequencing order and ticket events |
sequencing-tech | Sequencing Technology | Always on | Instrument registry, the sequencing-tech selector, and the barcode field type |
sequencing-tech cannot be disabled. The page also has a global kill switch
(globalDisabled) that forces every optional module off at once.
Modules explains which field types each one
contributes and why enabling a module is only half the job.
Related sections
- Installation — getting an instance running, including the bootstrap admin account created by the installer.
- Configuration — the full
settings.jsonand environment-variable reference behind these screens. - Updates & Maintenance — in-app updates and rollback.
- Reference → Data Model — the schema names behind the UI labels.