F Forge DocsRepository ↗FeaturesUser manual

Game servers & data

How workload databases work

Hosts, managed databases, sidecars, services, and catalog — pick the right one.

Repository-validated operator guidance View source ↗

#Rule of thumb

ToolMeaning
Database hostsConnect to existing shared MySQL/Postgres infrastructure you already run.
Managed databasesForge runs the database container with lifecycle, backups, restores, password rotation.
DB containersPer-server sidecar databases provisioned on Beacon.
Database servicesPlugin-system databases with diagnostics and query surfaces.
CatalogCurated one-click that picks one of the above for you.

#Hosts and per-server databases

Hosts register engine (postgres/postgresql → postgresql, mysql/mariadb → mysql), TLS mode (default verify-full), and max databases, optionally scoped to nodes. Per-server databases bind one logical database and user to a host; rows sit in pending until provisioned and stay on failure instead of vanishing. Passwords are encrypted with per-row keys and redacted from list APIs; test-connection endpoints verify without persisting.

FLOW

Database binding

01Register hostscope
02Bind databasecreate row
03Provision runsconnect
04Pending to ready

#Managed engines

Supported engines and versions are fixed in code: PostgreSQL 13–16, MySQL 8.0–8.3, MariaDB 10–11, Redis 6–7, MongoDB 6–7, with the standard ports. Managed databases run creating → running → stopped with error and deleting states, and keep backup/restore rows with pending, running, completed, and failed states.

Under /api/v1
GET|POST /database-hosts  POST .../test  POST .../:id/test
GET|POST /servers/:id/databases  POST .../rotate-password
GET  /managed-databases/engines
GET|POST /managed-databases  POST .../:id/backup|/restore
Made by Riyaz with love