Synaptic Four · Data and research

Ferrum

Ferrum shares research data through standard interfaces.

In short

Ferrum is a GA4GH gateway in Rust. It runs as an edge build on one computer, or as the full build with a database, object storage and a sign-in service. Early use, Apache 2.0.

Early use

Structure

Who does what, step by step.

On the left, your organisation with storage, sign-in and the approval service. In the middle, Ferrum with the interfaces. On the right, the partner. Arrows 1 to 5 are operation, finding, request, decision and delivery.

Your organisation

  • Storage for your files
  • Sign-in
  • Approval service, decides

Ferrum

  • Standard interfaces
  • checks the release
  • delivers the file
  • Log

Partner

  • finds
  • asks
  • downloads
  1. 1 Organisation runs it
  2. 2 Partner finds it
  3. 3 Request
  4. 4 Organisation decides
  5. 5 File is delivered

ferrum-gateway

The edge build and the full gateway are two builds of the same program in one source directory. The build decides which interfaces are included.

Storage, sign-in, release (of access)

The full build works with a database (Postgres), object storage (SeaweedFS) and a sign-in system (Keycloak). The release (of access) for a dataset comes from sign-in. Edge uses local files and listens only on its own computer until another address is set.

Log and time

Ferrum keeps a chained log of the events it records. The health check compares the system clock with a time server, pool.ntp.org by default. The server can be replaced.

Interfaces and standards

The source of the full build contains seven interfaces. Code that exists is not an end-to-end test.

Interfaces and standards
InterfaceWhat it meansBuildState
DRS a standard for finding and fetching files both
in the source
WES a standard for running analysis workflows full build only in the source
TES a standard for running analysis workflows full build only in the source
TRS a standard for registering analysis tools full build only in the source
htsget a standard for fetching sequencing files. In Ferrum today, whole files both
whole files today
Beacon asks whether a variant occurs, without showing the data both
part of the paths
Crypt4GH an encryption format for genomic files both in the source
Passports a standard for showing who may access what. The full build includes them from this program. With external sign-in, the log names ga4gh-infra full build, from this program
not in Edge

Components in operation

Components in operation
ComponentWhat it is forState
Postgres the database of the full build full build
SeaweedFS the object storage of the full build full build
Keycloak the sign-in system of the full build full build
Docker a path for starting a program with its dependencies
no Docker
Kubernetes an environment that runs many computers as one
It has not been installed yet.
Helm a package format for Kubernetes. The chart is included and has not been installed
It has not been installed yet.

Operation

Ferrum can run on your own infrastructure. Edge runs on one computer, including without Docker and without a database server. The guide names 8 to 16 GB of memory and 50 GB of free space for a lab laptop.
A Helm chart for Kubernetes is included. It has not been installed. The installation guide and the operator handbook are in the source tree. They do not state support terms.
In two tested setups, no outgoing connections were observed. That is not evidence for every configuration. The time check is provided for.

Security

Sign-in is on by default in the program itself. If the configuration file is invalid, Ferrum does not start.
Ferrum is written in Rust. The project’s own code has four unsafe places in three files.

Tests and evidence

The project’s own checks passed on 13 October 2026. Ferrum is checked with HelixTest. A passing run is not a seal of approval.
Four of the five programs that were checked produced the same checksums in two clean runs.

Licence

Ferrum is under the Apache licence 2.0. You may use it, change it and pass it on freely, including commercially.

Open code and licences

Licence file

Maturity

Early use

Evidence for Ferrum

Documentation on GitHub

Technical reports

The published reports belong to Ferrum.

Limits

htsget in Ferrum currently returns whole files. Regions are rejected.
The human Beacon offers part of the standard’s paths. Responses for people and samples, and the three access tiers, are among what is missing.
A separate Beacon for pathogens is decided, and it is not built.
  • The linked documents do not state support hours.
  • The Helm chart has not been installed.

Do you want to check the integration in your environment?

Check the Ferrum integration