Syfon documentation

Syfon is a Go implementation of the GA4GH Data Repository Service (DRS). It stores object metadata and signs access URLs for supported storage providers.

Use the guides by task:

• Quick Start starts a local server and checks its health endpoint.
• Local Deployment describes a SQLite and local-auth deployment.
• Kubernetes Deployment describes the Gen3 Helm chart values that matter to Syfon.
• Server Configuration lists the config file fields and environment overrides.
• Credential Encryption explains how Syfon protects stored bucket credentials.
• Plugin integration documents the authentication and authorization plugin contracts.
• Troubleshooting maps common startup and request failures to checks.

Developers can also read the OpenAPI code-generation guide, transfer metrics guide, and multipart download guide.

Architecture decisions are grouped under the Architecture Decisions section in the site navigation. Generated API contracts are served at /index/openapi.yaml when the docs route is enabled.