DoGaMa-serv/docs/PROJECT-STATE.md

DoGaMa project state

Read this compact operational baseline before starting a milestone. Open detailed domain documents only when the current work affects them.

Baseline

• Current reference: post-milestone-10 production-readiness branch from merged baseline deb1088.
• Released SQLite migrations: 0001 through 0009; never rewrite them.
• Roadmap milestones 1-10 are implemented; this is the V1 feature baseline.

Architecture

• Go main application: HTTP API, embedded server-rendered UI, authentication/authorization, SQLite, workflows, backups and WASM runtime.
• Private restricted Go agent: sole Docker-socket owner; authenticated typed API; registered-instance and plan-digest binding; no generic Docker proxy.
• Integrations: capability-scoped WebAssembly adapters only. Palworld REST is the reference module.
• Data: SQLite plus canonical allowed server, import and backup roots. Persistent game data lives outside containers.
• Contracts: declarative YAML templates and module manifests validated against JSON Schemas; released snapshots are immutable.

Implemented capabilities

• Bootstrap administrator, local authentication, secure sessions and CSRF protection.
• Validated embedded catalog, deterministic deployment previews and instance registry.
• Restricted instance create/inspect/start/stop/restart/delete and reconciliation.
• Per-instance memberships, overrides and installation requests with backend authorization.
• Backup scheduling/retention, safe imports, export and restore with safety backups.
• Sandboxed WASM runtime and normalized module API with Palworld reference adapter.
• Game-container configuration: global and per-instance labels, safe label variables, derived instance slug, immutable Docker-user selection, tracked/pinned image tags, immediate or deferred container recreation, and public game-logo/artwork routes.
• Controlled digest-aware game updates with confirmation, policy-driven pre-update backups, readiness verification, mod warnings and automatic container-plan rollback.
• Redacted configuration history retained to the latest 10 revisions, with pinned-template revalidation and immediate or deferred rollback.
• Declarative Steam Workshop item configuration with numeric-ID validation, stable ordering and backend mods.manage enforcement.
• Encrypted write-only SMTP, generic HTTPS webhook and Discord channels with event filters, queued test delivery, bounded retry and redacted terminal errors.
• SSRF-resistant HTTPS webhook delivery with redirect/address revalidation, event IDs, timestamps and optional HMAC-SHA256 signatures.
• Compact allow-listed audit events for authentication and significant mutations, administrator filtering, bounded manual purge, daily retention and maximum-count enforcement.
• Responsive server-rendered application shell with the official square DoGaMa logo, synthwave-derived design tokens, aligned permission-aware navigation, searchable real instance cards and state summaries above the server grid.
• Dedicated administrator Audit and Settings pages; notification channels, audit retention/purge and game-container labels retain their existing backend contracts outside the Dashboard.
• Restrictive browser headers and bounded public HTTP headers.
• Hardened read-only Compose services, capability dropping, private agent networking and distinct minimal OCI image targets.
• Linux black-box bootstrap/authentication E2E coverage plus a documented disposable-Docker V1 release verification matrix.
• Deterministic Linux amd64/arm64 archives with embedded build identity, SPDX module SBOM and SHA-256 checksums.
• Minimal production Compose with automatic persistent internal secrets, fixed container path boundaries and no user-managed application-to-agent settings.
• Gitea CI for pull requests and main, plus tag-only multi-architecture image publication and Gitea Release creation.

Durable decisions

• Editable Docker labels apply only to game-server instance containers.
• Labels on the DoGaMa application container remain Compose configuration and are never read, copied or edited by DoGaMa.
• Merge order is global labels, then instance labels; instance values win. Internal technical labels are applied last and cannot be overridden.
• dogama.* and io.dogama.* are reserved label namespaces.
• Label values support only the explicit allowlist in internal/instance/container_config.go; unknown variables are errors, not arbitrary templates.
• {{game.icon_url}} is the public icon for the game. {{instance.slug}} remains supported.
• Template game artwork contains separate required local logo and horizontal image assets; template validation rejects missing files. Deployment previews expose distinct logo and artwork URLs while retaining icon_url as a compatible logo alias. Palworld template 1.1.0 is the first snapshot with this contract.
• Instance slugs are derived from the display name, not canonical IDs. Accents are normalized to ASCII; whitespace, /, punctuation and special characters become safe hyphen separators; repeated and edge hyphens are removed.
• Docker user mode is fixed at creation to DoGaMa UID/GID, custom numeric UID/GID, or image-defined user. Never perform automatic recursive ownership changes.
• A pinned image tag is an explicit mutable tag, not an immutable digest. Tracked mode follows the template's declared default tag.
• Replacement-requiring changes use the generic container_config_pending desired-versus-applied state. Replacements preserve bind-mounted data and prior running/stopped intent.
• The main app never gains Docker-socket access; the agent remains deny-by-default and independently validates privileged plan fields.
• Update candidates are explicit tag@sha256:digest references. Mutable tags alone are rejected; automatic updates remain disabled.
• Mod configuration is data-only. Provider commands, scripts and arbitrary download URLs are forbidden.
• The application generates and retains its 32-byte master key outside SQLite; the agent never receives it. Ciphertext is authenticated AES-GCM and secrets are never returned by list APIs.
• agent_state remains durable because it stores both the shared token and the MAC-protected instance-to-container registry; losing it must never trigger automatic adoption.
• Notification delivery attempts are capped at five with exponential minute-scale backoff and never determine the originating operation result.
• Audit retention defaults to 30 days and 10,000 entries; zero explicitly selects unlimited retention/count within documented bounds.

Known limitations and debt

• Scheduled backup outcomes and repeated authentication blocks are audited/logged, but broader scheduler-origin notification coverage remains intentionally limited to events emitted by implemented workflows.
• Instance detail, catalog and backup management remain API-first; their sidebar entries are deliberately disabled until corresponding web pages exist, so navigation does not imply unavailable routes.
• Linux is the deployment target. Native Windows execution of the full Go suite is blocked by Unix Statfs code; use Linux/WSL/CI for complete execution.
• staticcheck, golangci-lint and Python specification dependencies may not be installed on every development host; report missing tooling rather than silently skipping or installing it.

Validation and CI

• .gitea/workflows/ci.yml validates pull requests and main; .gitea/workflows/release.yml publishes only tagged SemVer releases after the same required gate.
• Normal completion gate for Go changes is the validation set in AGENTS.md on Linux.
• Specification validation is python tools/validate_spec.py with tools/requirements-validation.txt available.
• Start with package/file-specific tests, then run global tests, build, race detection, vet, static analysis and schema validation as applicable.

Next known work

• No V1 milestone remains. Do not begin V1.x or V2 work without an explicit accepted scope.
• Update this file after every merged milestone or durable architectural change; keep it compact and remove stale statements.