Skip to Content
AdministrationOverview

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:

LayerWhere it livesPriority
Environment variablesSEQDESK_* in the process environmentHighest
Config filesettings.json next to the app (legacy: seqdesk.config.json)Middle
DatabaseWritten by the admin screens in this sectionLowest

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.

  1. Data Storage — point SeqDesk at the directory holding your FASTQ files. Nothing about sequencing files works until this is set.
  2. Pipeline Runtime — set the pipeline run directory, and Conda plus SLURM if you intend to run analyses.
  3. Departments — create them before researchers register, because the registration form only offers departments that already exist and are active.
  4. Modules — turn features on or off before customising forms, since a disabled module hides its field types everywhere.
  5. Sequencing Order Form — trim the intake form to what your facility actually needs to know.
  6. Sequencers — disable the instruments and kits you do not offer.
  7. ENA Configuration — only if you submit to the European Nucleotide Archive.
  8. 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

SidebarPathPage headingWhat it does
Researchers/admin/usersResearchersRead-only directory of RESEARCHER accounts with search, department and position filters, and per-user sequencing order and study history. See User Management.
Departments/admin/departmentsDepartmentsCreate, edit, activate and deactivate departments. See Departments.
Support/messagesSupportThe facility side of the ticket inbox. See Support & Messages.

Settings

SidebarPathPage headingWhat it does
Sequencing Order Form/admin/form-builderSequencing Order ConfigurationIntake form for sequencing orders. See Form Builders.
Study Forms/admin/study-form-builderStudy ConfigurationStudy questionnaire. Replaced by Define Studies when the dynamic-studies module is on.
Define Studies/admin/study-definitionsDefine StudiesPer-study questionnaires; only linked when dynamic-studies is enabled.
MIxS Checklists/admin/mixs-checklistsMIxS ChecklistsWhich MIxS environment checklists researchers may pick. See Study Metadata & MIxS.
Modules/admin/modulesModulesEnable or disable optional features (table below). See Modules.
Sequencers/admin/sequencing-techSequencing TechnologiesInstrument registry. See Sequencing Technologies.
MinKNOW Stream/admin/minknow-streamMinKNOW StreamLive Oxford Nanopore ingest: start, stop and pause the stream monitor.
Infrastructure/admin/data-computeInfrastructureReadiness hub that links to Data Storage and Pipeline Runtime, plus Import settings.json.
Background Workers/admin/background-workersBackground WorkersStart, stop and pause the stream-monitor and pipeline-monitor daemons and read their recent output. See Background Workers.
Accounts/admin/admin-accountsAdmin AccountsAdmin invites, plus the Department Sharing and User Assembly Downloads toggles.
Data Upload/admin/enaENA ConfigurationWebin credentials and submission history. See ENA Credentials.
Pipelines/admin/settings/pipelinesPipelinesPipeline catalogue: install and sync packages, download reference databases. See Pipelines & Analysis.
Notifications/admin/settings/notificationsNotification SettingsIn-app notification panel, hosted email relay, and which events send mail. See Notifications.
Info/admin/settingsPlatform InfoUpdates, 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:

PathPage headingReached from
/admin/data-storageData StorageInfrastructure, and the Data Storage button on Pipeline Runtime
/admin/pipeline-runtimePipeline RuntimeInfrastructure, and the Pipeline Runtime button on Data Storage
/admin/sequencing-run-form-builderSequencing Run FieldsInfo, 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 IDNameDefaultEffect
mixs-metadataMIxS MetadataOnMIxS checklist selection and standardised environment fields on studies and samples
ena-sample-fieldsENA Sample FieldsOnOrganism (NCBI taxonomy lookup), Sample Title, Sample Alias
ai-validationAI Field ValidationOnPer-field assisted validation with a custom prompt and strictness
funding-infoExternal Funding & GrantsOffGrant agency, grant number, project title, PI
billing-infoCost Center & PSPOffCost centre and PSP element with configurable format validation
dynamic-studiesDynamic Study DefinitionsOffMultiple study definitions, each with its own questionnaire, instead of one global study form
account-validationAccount ValidationOffRestrict registration to listed email domains
notificationsEmail NotificationsOffHosted email relay for sequencing order and ticket events
sequencing-techSequencing TechnologyAlways onInstrument 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.