You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Register upload services for a Virtool organization or user.
An uploader is a non-user identity that can upload sequencing data to Virtool. This could be a user-provided script, daemon, or the forthcoming official Virtool uploader service.
Ownership
Uploaders can be owned by organizations or users.
For users, files will simply be uploaded in the context of their account.
For organizations, files will by default be available to all organization members. However, the uploader can be configured with a user group that will automatically gain ownership of the files on upload. The API will also allow the uploader to specify a group for each request.
Authentication
Uploaders will have an assigned key that is essentially an API key that is only allowed to upload sequencing data files for a specific user or organization.
For the official Virtool upload service, we will provide a PIN match (see Plex or Android TV) system to automatically distribute the key from the Virtool server to the upload service on initial configuration. For other uploaders, the key can manually be copied and use for authentication as desired by the user.
Fields
Field
Description
id
unique ID for the uploader
name
display name for the uploader
description
long description for the uploader
created_at
when the uploader was created
user
the user the created the uploader; they will be the owner if an organization doesn't own the uploader
group
uploaded runs will automatically be assigned to this group; no effect for user-owned uploaders
organization
owning organization; will be null if owned by a user
pin
a four-character PIN used to initially link the uploader record and the uploader service
key
a secure key the uploader uses to identify itself; should have low potential for abuse
Instruments
Instruments will be auto-detected from runs or sequencing data files.
Fields
Field
Description
id
unique ID for the instrument
name
instrument name
make
instrument make (eg. Illumina)
model
the model of instrument; may link to another table of instruments
created_at
when the instrument was first detected in a run or sequencing file
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
Provide better ways of uploading read data.
Uploaders
Register upload services for a Virtool organization or user.
An uploader is a non-user identity that can upload sequencing data to Virtool. This could be a user-provided script, daemon, or the forthcoming official Virtool uploader service.
Ownership
Uploaders can be owned by organizations or users.
For users, files will simply be uploaded in the context of their account.
For organizations, files will by default be available to all organization members. However, the uploader can be configured with a user
group
that will automatically gain ownership of the files on upload. The API will also allow the uploader to specify agroup
for each request.Authentication
Uploaders will have an assigned key that is essentially an API key that is only allowed to upload sequencing data files for a specific user or organization.
For the official Virtool upload service, we will provide a PIN match (see Plex or Android TV) system to automatically distribute the key from the Virtool server to the upload service on initial configuration. For other uploaders, the key can manually be copied and use for authentication as desired by the user.
Fields
Instruments
Instruments will be auto-detected from runs or sequencing data files.
Fields
Beta Was this translation helpful? Give feedback.
All reactions