# HydroGo

> The high-performance Go commerce and headless application engine for modern brands.

HydroGo is an open-core, single-binary application engine written in Go. It combines an embedded SQLite/PostgreSQL database, declarative YAML content types, universal shopping cart pipelines, an embedded Svelte admin panel, and an autonomous Model Context Protocol (MCP) AI layer.

## Core URLs
- [HydroGo Home](https://hydrogo.dev/): Product overview, live interactive demo, architecture, benchmarks.
- [HydroGo Documentation](https://hydrogo.dev/docs): Full developer guide and API documentation.
- [GitHub (Open Core)](https://github.com/hydrohq/hydrogo): Community open-core source repository.
- [Arda Labs Studio](https://ardalabs.dev/): Engineering studio and creator of HydroGo.

## Comprehensive Full Text Context for LLMs
- [Full Documentation (llms-full.txt)](https://hydrogo.dev/llms-full.txt): Complete, unified markdown export containing all 14 HydroGo sections, code samples, REST API tables, YAML schemas, and MCP specifications.

## Open Core & Modules Ecosystem
- **Open Core (Free / PolyForm Shield):** Single-binary executable, SQLite WAL / Postgres RLS, REST API, embedded admin panel, cart & catalog.
- **Enterprise Modules (`hydro-modules`):** PayTR, iyzico, bank virtual POS, Geliver kargo, BizimHesap e-fatura, ERP sync.

## Documentation Index

### Introduction
- [What is HydroGo](https://hydrogo.dev/docs#introduction/what-is-hydrogo): A single-binary headless content management system written in Go. This page explains what it does, what it deliberately does not do, and who it is for.
- [Architecture](https://hydrogo.dev/docs#introduction/architecture): How the binary, the admin panel, the API and the storage layers fit together, and why publishing never needs a rebuild.
- [Core concepts](https://hydrogo.dev/docs#introduction/concepts): The vocabulary used throughout the docs: modules, content types, locales, roles, drafts and revisions.

### Getting started
- [Install](https://hydrogo.dev/docs#getting-started/install): Get the hydro command on Windows, Linux, macOS, in Docker, or build it from source.
- [Quick start](https://hydrogo.dev/docs#getting-started/quick-start): From nothing to a running admin panel and API in about a minute.
- [Presets](https://hydrogo.dev/docs#getting-started/presets): The five starting points for hydro new, which modules they enable and which content types they copy into your project.
- [Project layout](https://hydrogo.dev/docs#getting-started/project-layout): What hydro new writes to disk, what is safe to commit, and where each kind of change belongs.

### Configuration
- [config.yaml reference](https://hydrogo.dev/docs#configuration/config-file): Every commonly used key in config.yaml, what it does and its default. Copy config.example.yaml from the repository for a commented starting point.
- [Environment variables](https://hydrogo.dev/docs#configuration/environment-variables): Every HYDRO_* variable that overrides config.yaml, grouped by area. Use them for secrets and per-environment values.
- [Modules and profiles](https://hydrogo.dev/docs#configuration/modules-and-profiles): Turn features on and off with the modules list, and choose a capacity profile that matches your deployment size.

### Content types
- [Content types](https://hydrogo.dev/docs#content-types/overview): Model anything beyond pages and news with one YAML file. HydroGo derives storage, validation, admin screens and a public API from it.
- [Fields](https://hydrogo.dev/docs#content-types/fields): Every field kind and flag, which flags apply to which kinds, and how each kind appears in the admin and the API.
- [Relations, drafts and revisions](https://hydrogo.dev/docs#content-types/workflow): Link records to each other, add a publishing workflow and keep a history of changes.
- [Tooling and schema](https://hydrogo.dev/docs#content-types/tooling): The hydro content-type commands, JSON Schema for editor completion, and the stock types that ship with HydroGo.

### Commerce
- [Commerce Overview](https://hydrogo.dev/docs#commerce/overview): How HydroGo models catalogs, carts, checkout, inventory reservation, and payment providers in a single compiled Go binary.
- [Cart & Checkout API](https://hydrogo.dev/docs#commerce/cart-and-checkout): REST endpoints for customer carts, server-side pricing verification, and atomic checkout submission.
- [Payments & Integrations](https://hydrogo.dev/docs#commerce/payments-and-integrations): Pre-built local gateways: PayTR, iyzico, bank transfer (havale), Geliver shipping, and BizimHesap e-Invoicing.

### REST API
- [API overview](https://hydrogo.dev/docs#rest-api/overview): Base URL, the response envelope, the error shape, pagination and status codes shared by every endpoint.
- [Authentication](https://hydrogo.dev/docs#rest-api/authentication): Session cookie with CSRF, Bearer tokens and API keys, how to obtain each, and which endpoints need which.
- [Pages and news](https://hydrogo.dev/docs#rest-api/pages-and-news): List and read published pages and news articles, with curl and @hydrogo/client examples.
- [Content API](https://hydrogo.dev/docs#rest-api/content-api): Read published records of your YAML content types, with search, filters, sorting and locale.
- [Other public endpoints](https://hydrogo.dev/docs#rest-api/public-endpoints): Media, site settings, navigation, redirects, forms, search, sitemaps, Open Graph images and operational endpoints that need no credentials.
- [Member API](https://hydrogo.dev/docs#rest-api/members-api): Sign-up, sign-in and profile endpoints for the visitors of your site, designed for mobile apps and token-based clients.
- [Admin API](https://hydrogo.dev/docs#rest-api/admin-api): A map of the /api/v1/admin endpoints. The admin panel is a client of this API, so anything it does you can script.
- [Draft previews](https://hydrogo.dev/docs#rest-api/previews): Show unpublished pages and articles in your own frontend with signed, short-lived preview links.

### Admin panel
- [Admin panel overview](https://hydrogo.dev/docs#admin-guide/overview): Sign in, find your way around the embedded admin at /admin, and understand what each role can see.
- [Dashboard, pages, news and media](https://hydrogo.dev/docs#admin-guide/content): How editors create, review and publish content in the admin.
- [Content type screens](https://hydrogo.dev/docs#admin-guide/content-types-screens): The generic list and edit screens HydroGo generates from each YAML content type.
- [Members, users and roles](https://hydrogo.dev/docs#admin-guide/people): Manage site visitors (members) and the staff who use the admin, including invitations, roles and per-user permissions.
- [Site settings and system](https://hydrogo.dev/docs#admin-guide/site-and-system): Configure the site itself: general settings, navigation, forms, translations, redirects, maintenance mode, backups and diagnostics.

### Frontends
- [@hydrogo/client](https://hydrogo.dev/docs#frontends/client): A typed, dependency-free fetch client for the public API. Works in browsers, Node 20+, Deno, Bun and edge runtimes.
- [SvelteKit starter](https://hydrogo.dev/docs#frontends/sveltekit-starter): A small server-rendered site on the HydroGo API: the recommended shape for a real frontend.
- [SEO](https://hydrogo.dev/docs#frontends/seo): Canonical URLs, Open Graph, JSON-LD and sitemaps for a headless site.
- [Caching and webhooks](https://hydrogo.dev/docs#frontends/caching-and-webhooks): Keep the API fast with shared caching, and notify other systems when content changes.

### Multi-language
- [Content locales](https://hydrogo.dev/docs#multi-language/content-locales): Publish your site in several languages: the i18n configuration, per-locale pages and news, localized content type fields and the ?locale= parameter.
- [Admin interface language](https://hydrogo.dev/docs#multi-language/admin-language): Each person can pick the language of the admin panel; an administrator sets the project default. English and Turkish are included.

### AI & MCP Agent Guide
- [AI Control Plane & MCP](https://hydrogo.dev/docs#mcp/overview): How HydroGo's native Model Context Protocol (MCP) server enables AI coding agents to inspect, model, and mutate schemas at runtime.
- [Connecting AI Agents](https://hydrogo.dev/docs#mcp/setup): Step-by-step instructions to configure Cursor, Claude Desktop, and Claude Code with HydroGo MCP in under 30 seconds.
- [Available Tools & Audit](https://hydrogo.dev/docs#mcp/tools-and-security): The 4 core tools exposed by HydroGo's MCP server and the SHA-256 cryptographic audit chain.

### Security
- [Hardening checklist](https://hydrogo.dev/docs#security/hardening): CSRF protection, secure cookies, HSTS, security headers, rate limiting and the other defences that are on by default or one setting away.
- [Accounts, MFA and API keys](https://hydrogo.dev/docs#security/accounts-and-access): Roles and permissions, TOTP multi-factor authentication, personal tokens and API keys.
- [Audit trail](https://hydrogo.dev/docs#security/audit-trail): Who changed what and when, plus optional redacted request bodies for admin API calls.
- [Reporting vulnerabilities](https://hydrogo.dev/docs#security/reporting): Supported versions and how to report a security issue privately.

### Deployment
- [VPS with systemd and a proxy](https://hydrogo.dev/docs#deployment/vps): Run HydroGo on any Linux server as a systemd service behind Caddy or nginx for TLS.
- [Docker](https://hydrogo.dev/docs#deployment/docker): Run the published image, or the production Compose stack with Caddy, PostgreSQL and Redis.
- [Shared hosting (CGI and FastCGI)](https://hydrogo.dev/docs#deployment/shared-hosting): Deploy on Apache-style shared hosting where you cannot run a long-lived process.
- [Databases, Redis and media storage](https://hydrogo.dev/docs#deployment/databases-and-storage): Choose SQLite, PostgreSQL or MySQL, add Redis for several instances, and move media to S3.
- [Backups and restore](https://hydrogo.dev/docs#deployment/backups): Back up the database and media, verify them, and practise a restore before you need one.
- [Health, metrics and diagnostics](https://hydrogo.dev/docs#deployment/monitoring): Probes for load balancers, Prometheus metrics, the doctor command and error reporting.

### Upgrading
- [Versioning policy](https://hydrogo.dev/docs#upgrading/versioning): How HydroGo numbers releases, what a version bump may break, and how database migrations are handled.
- [Upgrade steps and rollback](https://hydrogo.dev/docs#upgrading/upgrade-steps): A safe, repeatable procedure: back up, replace the binary, check, migrate, verify. And how to roll back.
- [Release process](https://hydrogo.dev/docs#upgrading/releasing): For maintainers: how a tagged release produces binaries, the Windows installer, checksums and container images.

### Reference
- [CLI reference](https://hydrogo.dev/docs#reference/cli): Every hydro command, grouped by purpose, with the flags it accepts. Run hydro help for the same list offline.
- [Troubleshooting](https://hydrogo.dev/docs#reference/troubleshooting): Symptoms, causes and fixes for the problems people hit most often. Start with the request id.
- [FAQ](https://hydrogo.dev/docs#reference/faq): Short answers to the questions that come up before and after choosing HydroGo.
- [Contributing](https://hydrogo.dev/docs#reference/contributing): Set up the repository, run the checks, and follow the few architecture rules that keep HydroGo small.

## Contact & Source Code
- Website: https://hydrogo.dev
- Parent Studio: https://ardalabs.dev
- Email: contact@ardalabs.dev
- GitHub: https://github.com/hydrohq/hydrogo
- License: PolyForm Shield 1.0.0