The GroCMS handbook

Documentation sources

Implementation references and official documentation behind the GroCMS guides.

GroCMS 0.1.0 · Reviewed 15 September 2026

Repository references identify files in the GroCMS source checkout. They are plain citations, not public file downloads. Official links explain the underlying technologies; the implemented product behavior described in each guide takes precedence over an upstream feature that GroCMS does not enable.

Getting started

  1. Workspace navigation and screen routing

    Repository path: apps/cms/src/components/admin/shell.tsx

  2. Content editor controls

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

  3. Revision and publication service

    Repository path: apps/cms/src/cms/services/content.ts

  4. Account invitation workflow

    Repository path: apps/cms/src/cms/auth/people.ts

  5. Initial workspace setup

    Repository path: apps/cms/scripts/setup.ts

  6. Documentation routes and rendering

    Repository path: apps/cms/src/components/documentation/article.tsx

  7. Reviewed public guide selection and links

    Repository path: apps/cms/src/cms/documentation/public.ts

How the CMS works

  1. Resource and revision contracts

    Repository path: apps/cms/src/cms/contracts.ts

  2. Registered content types

    Repository path: apps/cms/src/cms/definitions/index.ts

  3. Save, publish, restore, preview and schedule services

    Repository path: apps/cms/src/cms/services/content.ts

  4. Public snapshot and query loader

    Repository path: apps/cms/src/cms/services/public.ts

  5. Private media access and versioning

    Repository path: apps/cms/src/cms/services/media.ts

  6. Role and capability policy

    Repository path: apps/cms/src/cms/policy/index.ts

  7. Transactional queue configuration

    Repository path: apps/cms/src/cms/jobs/queue.ts

  8. Worker execution and retry handling

    Repository path: apps/cms/src/worker/handlers.ts

  9. PostgreSQL 18: Transaction Isolation

    Repeatable-read background; CMS access policy is implemented in the cited source.

  10. ORM Transaction Adapters

    Explains transaction-bound enqueue; the application pins 12.30.0, while this rolling documentation currently identifies 12.31.0.

Technology stack

  1. Pinned dependencies and commands

    Repository path: apps/cms/package.json

    Application baseline 9e608fe; the lockfile records the resolved dependency tree.

  2. Web and operations image definitions

    Repository path: Dockerfile

  3. Production process and PostgreSQL configuration

    Repository path: compose.yaml

  4. Relational CMS schema

    Repository path: apps/cms/src/cms/db/schema.ts

  5. Migration, integrity and privilege setup

    Repository path: apps/cms/scripts/migrate.ts

  6. Public eligibility and search queries

    Repository path: apps/cms/src/cms/services/public.ts

  7. Shared Puck component configuration

    Repository path: apps/cms/src/cms/components/config.tsx

  8. Server-side content validation

    Repository path: apps/cms/src/cms/validation.ts

  9. Authentication integration contract

    Repository path: apps/cms/src/cms/auth/README.md

  10. Verification and acceptance evidence

    Repository path: docs/build-status.md

  11. Measured performance and limits

    Repository path: docs/evidence/performance.md

  12. Executed operations and recovery evidence

    Repository path: docs/evidence/operations-runtime.md

  13. Self-hosting Next.js

    Framework background; application-specific packaging comes from Dockerfile.

  14. Drizzle schema declarations
  15. Getting Started
  16. Next.js integration

Glossary

  1. Core content contracts

    Repository path: apps/cms/src/cms/contracts.ts

  2. Registered content definitions

    Repository path: apps/cms/src/cms/definitions/index.ts

  3. Database schema

    Repository path: apps/cms/src/cms/db/schema.ts

  4. Revision and publication workflow

    Repository path: apps/cms/src/cms/services/content.ts

  5. Visual component configuration

    Repository path: apps/cms/src/cms/components/config.tsx

  6. Supported brand token controls

    Repository path: apps/cms/src/components/admin/brand-fields.tsx

  7. Public component styles and theme limits

    Repository path: apps/cms/src/app/globals.css

  8. Public rendering data resolution

    Repository path: apps/cms/src/cms/services/public.ts

  9. Operational terminology and recovery

    Repository path: docs/operations.md

  10. Deployment services

    Repository path: compose.yaml

Overview

  1. Overview screen

    Repository path: apps/cms/src/components/admin/dashboard.tsx

    Current labels, shortcuts and six-entry recent-content table.

  2. Overview and workflow queries

    Repository path: apps/cms/src/cms/services/management.ts

    Permission-filtered counts, review decisions, queue search and pagination.

  3. Content lists and creation dialogs

    Repository path: apps/cms/src/components/admin/content-list.tsx

    Search, status filters, selection, pagination and creation controls.

  4. Resource editor

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Content fields, permissions, autosave, history, publication and scheduling dialogs.

  5. Content and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Draft isolation, route rules, profile ownership, exact review/schedule targets and recovery.

  6. Resource permission policy

    Repository path: apps/cms/src/cms/policy/index.ts

    Administrator, editor, author, contributor and designer capabilities.

  7. Optional enquiry inbox and delivery rules

    Repository path: apps/cms/src/cms/services/enquiries.ts

    Private demo/quote submissions, administrator access, notification state and deletion.

  8. Administrator enquiry inbox

    Repository path: apps/cms/src/components/admin/enquiries-panel.tsx

Pages

  1. Content types and taxonomies

    Repository path: apps/cms/src/cms/definitions/index.ts

    Pages, Posts, Events, Vehicles and their allowed classifications.

  2. Resource permission policy

    Repository path: apps/cms/src/cms/policy/index.ts

    Administrator, editor, author, contributor and designer capabilities.

  3. Content lists and creation dialogs

    Repository path: apps/cms/src/components/admin/content-list.tsx

    Search, status filters, selection, pagination and creation controls.

  4. Resource editor

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Content fields, permissions, autosave, history, publication and scheduling dialogs.

  5. Reference selection dialog

    Repository path: apps/cms/src/components/admin/reference-picker.tsx

    Search, taxonomy selector, multiple selection and older result pages.

  6. Content and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Draft isolation, route rules, profile ownership, exact review/schedule targets and recovery.

  7. Published-content integration tests

    Repository path: apps/cms/tests/integration/public.test.ts

    Page moves, redirects, publication isolation, taxonomy queries and historical restore.

  8. Editor browser journeys

    Repository path: apps/cms/tests/editor-browser.ts

    Actual autosave, conflict recovery, rich text, media replacement and older selections.

  9. Bulk actions

    Repository path: apps/cms/src/components/admin/bulk-actions.tsx

    Per-entry decisions, saved-revision publication and selected-snapshot downloads.

Posts

  1. Content types and taxonomies

    Repository path: apps/cms/src/cms/definitions/index.ts

    Pages, Posts, Events, Vehicles and their allowed classifications.

  2. Resource permission policy

    Repository path: apps/cms/src/cms/policy/index.ts

    Administrator, editor, author, contributor and designer capabilities.

  3. Resource editor

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Content fields, permissions, autosave, history, publication and scheduling dialogs.

  4. Content lists and creation dialogs

    Repository path: apps/cms/src/components/admin/content-list.tsx

    Search, status filters, selection, pagination and creation controls.

  5. Reference selection dialog

    Repository path: apps/cms/src/components/admin/reference-picker.tsx

    Search, taxonomy selector, multiple selection and older result pages.

  6. Content and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Draft isolation, route rules, profile ownership, exact review/schedule targets and recovery.

  7. Authority and media integration tests

    Repository path: apps/cms/tests/auth-authority.integration.test.ts

    Own profiles, media versions, page traversal, private references and account revocation.

  8. Two-role review browser journey

    Repository path: apps/cms/tests/review-browser.ts

    Contributor submission and editor publication of the exact reviewed revision.

  9. Published-content integration tests

    Repository path: apps/cms/tests/integration/public.test.ts

    Page moves, redirects, publication isolation, taxonomy queries and historical restore.

  10. Editor browser journeys

    Repository path: apps/cms/tests/editor-browser.ts

    Actual autosave, conflict recovery, rich text, media replacement and older selections.

  11. Bulk actions

    Repository path: apps/cms/src/components/admin/bulk-actions.tsx

    Per-entry decisions, saved-revision publication and selected-snapshot downloads.

Media library

  1. Media library screen

    Repository path: apps/cms/src/components/admin/media-library.tsx

    Batch upload, search, pages and media details; no delete button is provided.

  2. Media replacement dialog

    Repository path: apps/cms/src/components/admin/media-version-form.tsx

    Name, alternative text and optional replacement file create a new version.

  3. Media storage and access rules

    Repository path: apps/cms/src/cms/services/media.ts

    File validation, normalisation, immutable versions, private delivery and retained-reference deletion protection.

  4. Resource permission policy

    Repository path: apps/cms/src/cms/policy/index.ts

    Administrator, editor, author, contributor and designer capabilities.

  5. Authority and media integration tests

    Repository path: apps/cms/tests/auth-authority.integration.test.ts

    Own profiles, media versions, page traversal, private references and account revocation.

  6. Editor browser journeys

    Repository path: apps/cms/tests/editor-browser.ts

    Actual autosave, conflict recovery, rich text, media replacement and older selections.

Categories & tags

  1. Content types and taxonomies

    Repository path: apps/cms/src/cms/definitions/index.ts

    Pages, Posts, Events, Vehicles and their allowed classifications.

  2. Public content and archive selection

    Repository path: apps/cms/src/cms/services/public.ts

    Published taxonomy descendants, profile archives and public visibility.

  3. Content lists and creation dialogs

    Repository path: apps/cms/src/components/admin/content-list.tsx

    Search, status filters, selection, pagination and creation controls.

  4. Resource editor

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Content fields, permissions, autosave, history, publication and scheduling dialogs.

  5. Content and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Draft isolation, route rules, profile ownership, exact review/schedule targets and recovery.

  6. Resource permission policy

    Repository path: apps/cms/src/cms/policy/index.ts

    Administrator, editor, author, contributor and designer capabilities.

  7. Reference selection dialog

    Repository path: apps/cms/src/components/admin/reference-picker.tsx

    Search, taxonomy selector, multiple selection and older result pages.

  8. Published-content integration tests

    Repository path: apps/cms/tests/integration/public.test.ts

    Page moves, redirects, publication isolation, taxonomy queries and historical restore.

Authors

  1. Content and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Draft isolation, route rules, profile ownership, exact review/schedule targets and recovery.

  2. Resource editor

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Content fields, permissions, autosave, history, publication and scheduling dialogs.

  3. Resource permission policy

    Repository path: apps/cms/src/cms/policy/index.ts

    Administrator, editor, author, contributor and designer capabilities.

  4. Content lists and creation dialogs

    Repository path: apps/cms/src/components/admin/content-list.tsx

    Search, status filters, selection, pagination and creation controls.

  5. Profile and older-page browser journeys

    Repository path: apps/cms/tests/admin-pagination-browser.ts

    Author profile creation and body save/reload, designer read-only access and older workflow entries.

  6. Authority and media integration tests

    Repository path: apps/cms/tests/auth-authority.integration.test.ts

    Own profiles, media versions, page traversal, private references and account revocation.

  7. Public content and archive selection

    Repository path: apps/cms/src/cms/services/public.ts

    Published taxonomy descendants, profile archives and public visibility.

  8. Published-content integration tests

    Repository path: apps/cms/tests/integration/public.test.ts

    Page moves, redirects, publication isolation, taxonomy queries and historical restore.

Review queue

  1. Review and schedule screens

    Repository path: apps/cms/src/components/admin/operations.tsx

    Exact submitted-revision inspection, decisions, publication and cancellation controls.

  2. Overview and workflow queries

    Repository path: apps/cms/src/cms/services/management.ts

    Permission-filtered counts, review decisions, queue search and pagination.

  3. Content and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Draft isolation, route rules, profile ownership, exact review/schedule targets and recovery.

  4. Resource editor

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Content fields, permissions, autosave, history, publication and scheduling dialogs.

  5. Resource permission policy

    Repository path: apps/cms/src/cms/policy/index.ts

    Administrator, editor, author, contributor and designer capabilities.

  6. Two-role review browser journey

    Repository path: apps/cms/tests/review-browser.ts

    Contributor submission and editor publication of the exact reviewed revision.

Publishing schedule

  1. Resource editor

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Content fields, permissions, autosave, history, publication and scheduling dialogs.

  2. Content and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Draft isolation, route rules, profile ownership, exact review/schedule targets and recovery.

  3. Publication and worker integration tests

    Repository path: apps/cms/tests/integration/publication.test.ts

    Pinned scheduling, cancellation, restart, retries and dependency protection.

  4. Local date and time input

    Repository path: apps/cms/src/components/admin/local-datetime-input.tsx

    Local time, daylight-saving gaps and explicit ambiguous-time choices.

  5. Resource permission policy

    Repository path: apps/cms/src/cms/policy/index.ts

    Administrator, editor, author, contributor and designer capabilities.

  6. Review and schedule screens

    Repository path: apps/cms/src/components/admin/operations.tsx

    Exact submitted-revision inspection, decisions, publication and cancellation controls.

  7. Overview and workflow queries

    Repository path: apps/cms/src/cms/services/management.ts

    Permission-filtered counts, review decisions, queue search and pagination.

Languages and translations

  1. Localization implementation and operations guide

    Repository path: docs/localization.md

  2. Language configuration and prefix validation

    Repository path: apps/cms/src/cms/services/localization.ts

  3. Administrator language setup

    Repository path: apps/cms/src/components/admin/languages.tsx

  4. Translation editing controls

    Repository path: apps/cms/src/components/admin/translations.tsx

  5. Resource editor sessions and recovery

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

  6. Translation creation and revision ownership

    Repository path: apps/cms/src/cms/services/content.ts

  7. Typed translation reference remapping

    Repository path: apps/cms/src/cms/translations.ts

  8. Localized public rendering and search

    Repository path: apps/cms/src/cms/services/public.ts

  9. Locale variant migration

    Repository path: apps/cms/drizzle/0006_locale_variants.sql

  10. Default-language site manifest contract

    Repository path: apps/cms/scripts/site-manifest.ts

Homepage

  1. Public page selection and resource resolution

    Repository path: apps/cms/src/cms/services/public.ts

    Homepage and template precedence, published resource selection, connected collections, menus, and shared dependencies.

  2. Public website frame and theme application

    Repository path: apps/cms/src/app/site-view.tsx

    Header, footer, default layouts, archive listings, brand colors, and WOFF2 font application.

  3. Reference website content

    Repository path: apps/cms/scripts/seed.ts

    Initial home template, shared resources, brand, navigation, and example content.

  4. Resource editor and design resource fields

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Native controls, autosave, publication actions, permissions, template keys, homepage settings, and navigation link editing.

  5. Puck integration and editor configuration

    Repository path: apps/cms/src/cms/editor/composition-editor.tsx

    Available canvas sizes, native rich text, remote resource pickers, patterns, and read-only behavior.

  6. Configured website components

    Repository path: apps/cms/src/cms/components/config.tsx

    The actual component labels, editable fields, slot definitions, and rendering behavior.

  7. Role and resource permissions

    Repository path: apps/cms/src/cms/policy/index.ts

    Design resources belong to administrator and designer capabilities; content permissions differ.

  8. Built-in layout patterns

    Repository path: apps/cms/src/cms/editor/patterns.ts

    Welcome, article, and two-column layouts; copied components receive independent identifiers.

  9. Settings navigation

    Repository path: apps/cms/src/components/admin/settings.tsx

    Settings overview and the Manage settings route to the site settings record.

  10. Revision and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Immutable revisions, required published dependencies, cycle checks, preview selection, and publication actions.

  11. Website component styles

    Repository path: apps/cms/src/app/globals.css

    Responsive columns, typography, public theme variables, section tones and hero decoration.

Visual editor

  1. Puck integration and editor configuration

    Repository path: apps/cms/src/cms/editor/composition-editor.tsx

    Available canvas sizes, native rich text, remote resource pickers, patterns, and read-only behavior.

  2. Resource editor and design resource fields

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Native controls, autosave, publication actions, permissions, template keys, homepage settings, and navigation link editing.

  3. Configured website components

    Repository path: apps/cms/src/cms/components/config.tsx

    The actual component labels, editable fields, slot definitions, and rendering behavior.

  4. Slot field

    Framework background only: a slot is a nested drag-and-drop area. GroCMS limits come from its own validation.

  5. Rich Text Editing

    Framework background only. GroCMS provides its own configured controls and canonical HTML persistence.

  6. Built-in layout patterns

    Repository path: apps/cms/src/cms/editor/patterns.ts

    Welcome, article, and two-column layouts; copied components receive independent identifiers.

  7. Editor browser verification

    Repository path: apps/cms/tests/editor-browser.ts

    Save/reload evidence for canonical rich text, slots, copied layouts, brand tokens, menus, and remote selection.

  8. Website component styles

    Repository path: apps/cms/src/app/globals.css

    Responsive columns, typography, public theme variables, section tones and hero decoration.

  9. Public page selection and resource resolution

    Repository path: apps/cms/src/cms/services/public.ts

    Homepage and template precedence, published resource selection, connected collections, menus, and shared dependencies.

  10. Content and composition validation

    Repository path: apps/cms/src/cms/validation.ts

    Layout size, nesting, supported components, safe links, menu limits, color validation, and resource references.

  11. Revision and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Immutable revisions, required published dependencies, cycle checks, preview selection, and publication actions.

  12. Role and resource permissions

    Repository path: apps/cms/src/cms/policy/index.ts

    Design resources belong to administrator and designer capabilities; content permissions differ.

Templates

  1. Public page selection and resource resolution

    Repository path: apps/cms/src/cms/services/public.ts

    Homepage and template precedence, published resource selection, connected collections, menus, and shared dependencies.

  2. Configured website components

    Repository path: apps/cms/src/cms/components/config.tsx

    The actual component labels, editable fields, slot definitions, and rendering behavior.

  3. Resource editor and design resource fields

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Native controls, autosave, publication actions, permissions, template keys, homepage settings, and navigation link editing.

  4. Puck integration and editor configuration

    Repository path: apps/cms/src/cms/editor/composition-editor.tsx

    Available canvas sizes, native rich text, remote resource pickers, patterns, and read-only behavior.

  5. Built-in layout patterns

    Repository path: apps/cms/src/cms/editor/patterns.ts

    Welcome, article, and two-column layouts; copied components receive independent identifiers.

  6. Revision and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Immutable revisions, required published dependencies, cycle checks, preview selection, and publication actions.

  7. Public website frame and theme application

    Repository path: apps/cms/src/app/site-view.tsx

    Header, footer, default layouts, archive listings, brand colors, and WOFF2 font application.

  8. Role and resource permissions

    Repository path: apps/cms/src/cms/policy/index.ts

    Design resources belong to administrator and designer capabilities; content permissions differ.

Shared sections

  1. Configured website components

    Repository path: apps/cms/src/cms/components/config.tsx

    The actual component labels, editable fields, slot definitions, and rendering behavior.

  2. Public page selection and resource resolution

    Repository path: apps/cms/src/cms/services/public.ts

    Homepage and template precedence, published resource selection, connected collections, menus, and shared dependencies.

  3. Built-in layout patterns

    Repository path: apps/cms/src/cms/editor/patterns.ts

    Welcome, article, and two-column layouts; copied components receive independent identifiers.

  4. Resource editor and design resource fields

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Native controls, autosave, publication actions, permissions, template keys, homepage settings, and navigation link editing.

  5. Puck integration and editor configuration

    Repository path: apps/cms/src/cms/editor/composition-editor.tsx

    Available canvas sizes, native rich text, remote resource pickers, patterns, and read-only behavior.

  6. Revision and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Immutable revisions, required published dependencies, cycle checks, preview selection, and publication actions.

  7. Searchable reference selection

    Repository path: apps/cms/src/components/admin/reference-picker.tsx

    Remote search, pagination, selected entry resolution, and published-only choices.

  8. Public website frame and theme application

    Repository path: apps/cms/src/app/site-view.tsx

    Header, footer, default layouts, archive listings, brand colors, and WOFF2 font application.

  9. Reference website content

    Repository path: apps/cms/scripts/seed.ts

    Initial home template, shared resources, brand, navigation, and example content.

  10. Content and composition validation

    Repository path: apps/cms/src/cms/validation.ts

    Layout size, nesting, supported components, safe links, menu limits, color validation, and resource references.

  11. Role and resource permissions

    Repository path: apps/cms/src/cms/policy/index.ts

    Design resources belong to administrator and designer capabilities; content permissions differ.

Navigation

Brand & theme

  1. Brand foundations form

    Repository path: apps/cms/src/components/admin/brand-fields.tsx

    Color and font controls, logo selection, and validated brand token import/export.

  2. Official GroCMS brand defaults

    Repository path: apps/cms/src/cms/brand/preset.ts

    Approved Concept 05 assets, accessible action colors, official site defaults and product interface tokens.

  3. Shared public brand resolver

    Repository path: apps/cms/src/cms/brand/theme.ts

    Saved overrides, legacy font choices, custom assets, logo display and supported version-one tokens.

  4. Site icon and social image selection

    Repository path: apps/cms/src/cms/brand/metadata.ts

    Published custom icon and social-image selection, official fallbacks and preview metadata behavior.

  5. Public website frame and theme application

    Repository path: apps/cms/src/app/site-view.tsx

    Header, footer, default layouts, archive listings, brand colors, and WOFF2 font application.

  6. Public page selection and resource resolution

    Repository path: apps/cms/src/cms/services/public.ts

    Homepage and template precedence, published resource selection, connected collections, menus, and shared dependencies.

  7. Role and resource permissions

    Repository path: apps/cms/src/cms/policy/index.ts

    Design resources belong to administrator and designer capabilities; content permissions differ.

  8. Configured website components

    Repository path: apps/cms/src/cms/components/config.tsx

    The actual component labels, editable fields, slot definitions, and rendering behavior.

  9. Content and composition validation

    Repository path: apps/cms/src/cms/validation.ts

    Layout size, nesting, supported components, safe links, menu limits, color validation, and resource references.

  10. Website component styles

    Repository path: apps/cms/src/app/globals.css

    Responsive columns, typography, public theme variables, section tones and hero decoration.

  11. Media validation and immutable versions

    Repository path: apps/cms/src/cms/services/media.ts

    Supported uploads, WOFF2 handling, access checks, and replacement versions.

  12. Revision and publication service

    Repository path: apps/cms/src/cms/services/content.ts

    Immutable revisions, required published dependencies, cycle checks, preview selection, and publication actions.

  13. Editor browser verification

    Repository path: apps/cms/tests/editor-browser.ts

    Save/reload evidence for canonical rich text, slots, copied layouts, brand tokens, menus, and remote selection.

  14. Resource editor and design resource fields

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

    Native controls, autosave, publication actions, permissions, template keys, homepage settings, and navigation link editing.

People & permissions

  1. Role and ownership policy

    Repository path: apps/cms/src/cms/policy/index.ts

  2. People screen

    Repository path: apps/cms/src/cms/auth/people-panel.tsx

  3. Invitation and access-change service

    Repository path: apps/cms/src/cms/auth/people.ts

  4. Account forms

    Repository path: apps/cms/src/cms/auth/forms.tsx

  5. Authentication and current-account resolution

    Repository path: apps/cms/src/cms/auth/server.ts

  6. Content ownership and protected fields

    Repository path: apps/cms/src/cms/services/content.ts

  7. Media access policy

    Repository path: apps/cms/src/cms/services/media.ts

Activity log

  1. Activity log interface

    Repository path: apps/cms/src/components/admin/operations.tsx

  2. Audit filtering and pagination

    Repository path: apps/cms/src/cms/services/management.ts

  3. Audit permission

    Repository path: apps/cms/src/cms/policy/index.ts

  4. Content audit events

    Repository path: apps/cms/src/cms/services/content.ts

  5. People audit events

    Repository path: apps/cms/src/cms/auth/people.ts

  6. Workspace export payload

    Repository path: apps/cms/src/app/api/cms/[...path]/route.ts

  7. Backup and recovery runbook

    Repository path: docs/operations.md

Settings

  1. Settings hub

    Repository path: apps/cms/src/components/admin/settings.tsx

  2. Core update management screen

    Repository path: apps/cms/src/components/admin/system-updates.tsx

  3. Core update authority and request contracts

    Repository path: apps/cms/src/cms/api/updates.ts

  4. System updates guide

    Repository path: docs/system-updates.md

  5. Site settings fields and save flow

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

  6. Public homepage and configuration selection

    Repository path: apps/cms/src/cms/services/public.ts

  7. Settings publication validation

    Repository path: apps/cms/src/cms/services/content.ts

  8. Registered public archive routes

    Repository path: apps/cms/src/cms/definitions/index.ts

  9. Design and administrator permissions

    Repository path: apps/cms/src/cms/policy/index.ts

  10. Production services and environment

    Repository path: compose.yaml

  11. Environment configuration template

    Repository path: .env.example

Account & security

  1. Account security interface

    Repository path: apps/cms/src/cms/auth/security-panel.tsx

  2. Sign-in, reset and MFA forms

    Repository path: apps/cms/src/cms/auth/forms.tsx

  3. Authentication configuration

    Repository path: apps/cms/src/cms/auth/server.ts

  4. Provisioning and account state

    Repository path: apps/cms/src/cms/auth/people.ts

  5. Better Auth: Email & Password

    Library background; the GroCMS configuration determines its actual password and recovery rules.

  6. Better Auth: Two-Factor Authentication

    Library background for time-based codes and recovery codes; see local source for the enabled interface.

API keys & content export

  1. API key controls and export link

    Repository path: apps/cms/src/components/admin/settings.tsx

  2. CMS API routes and export implementation

    Repository path: apps/cms/src/app/api/cms/[...path]/route.ts

  3. Bearer credential resolution and API request authentication

    Repository path: apps/cms/src/cms/http.ts

  4. Permission and scope intersection

    Repository path: apps/cms/src/cms/policy/index.ts

  5. REST API contract

    Repository path: docs/api-contract.md

  6. Selected-content export format and scope

    Repository path: apps/cms/src/components/admin/bulk-actions.tsx

  7. Content list selection and full-export permission

    Repository path: apps/cms/src/components/admin/content-list.tsx

  8. Backup operations

    Repository path: docs/operations.md

Content types and extensions

  1. Installed type and taxonomy registry

    Repository path: apps/cms/src/cms/definitions/index.ts

  2. TypeDefinition and supported scalar fields

    Repository path: apps/cms/src/cms/contracts.ts

  3. Content type builder and catalogue

    Repository path: apps/cms/src/components/admin/type-builder.tsx

  4. Content type retirement and permanent deletion

    Repository path: apps/cms/src/cms/services/type-lifecycle.ts

  5. Content-type and component extension contract

    Repository path: docs/developer-guide.md

  6. Field, composition and reference validation

    Repository path: apps/cms/src/cms/validation.ts

  7. Component rendering and fields

    Repository path: apps/cms/src/cms/components/config.tsx

  8. Archive route registration

    Repository path: apps/cms/src/cms/services/content.ts

  9. Capability rules

    Repository path: apps/cms/src/cms/policy/index.ts

  10. SQL visibility rules

    Repository path: apps/cms/src/cms/policy/query.ts

  11. Relational schema

    Repository path: apps/cms/src/cms/db/schema.ts

  12. Executed generic extension exercise

    Repository path: docs/evidence/extension-exercise.md

  13. Drizzle schema declarations

    Schema and migration-generation background; CMS compatibility rules are application-specific.

Local setup

  1. Local installation and verification

    Repository path: README.md

  2. Supported Node engine and npm scripts

    Repository path: apps/cms/package.json

  3. Private local environment generator

    Repository path: scripts/init-local.mjs

  4. Development PostgreSQL and Mailpit services

    Repository path: compose.dev.yaml

  5. Application and queue migration runner

    Repository path: apps/cms/scripts/migrate.ts

  6. First account and installation setup

    Repository path: apps/cms/scripts/setup.ts

  7. Starter resource creation

    Repository path: apps/cms/scripts/starters.ts

  8. Optional demo and untouched-starter guard

    Repository path: apps/cms/scripts/seed.ts

  9. Separate worker process

    Repository path: apps/cms/src/worker/index.ts

  10. Isolated test database initializer

    Repository path: scripts/init-test.mjs

  11. Control startup and shutdown order in Compose

Production setup and upgrades

  1. Production services and environment

    Repository path: compose.yaml

  2. Validated installation feature switches

    Repository path: apps/cms/src/cms/installation.ts

  3. Public documentation route protection

    Repository path: apps/cms/src/cms/services/content.ts

  4. Private enquiry processing

    Repository path: apps/cms/src/cms/services/enquiries.ts

  5. Standalone and operations images

    Repository path: Dockerfile

  6. Deployment and operational policy

    Repository path: docs/operations.md

  7. Production environment generator

    Repository path: scripts/ops/init-production-env.mjs

  8. Initial production database roles

    Repository path: ops/postgres/001-roles.sh

  9. Controlled deployment helper

    Repository path: scripts/ops/deploy.mjs

  10. Deployment lock and migrations

    Repository path: apps/cms/scripts/migrate.ts

  11. Private production bootstrap helper

    Repository path: scripts/ops/setup.mjs

  12. First administrator and minimal starter site

    Repository path: apps/cms/scripts/setup.ts

  13. Demo seed protection

    Repository path: apps/cms/scripts/seed.ts

  14. Readiness endpoint

    Repository path: apps/cms/src/app/api/ready/route.ts

  15. Worker readiness and paused mode

    Repository path: apps/cms/src/worker/index.ts

  16. Verified production installation

    Repository path: docs/evidence/final-production-install.json

  17. Self-hosting Next.js

    Server/browser environment distinction and reverse-proxy background.

Backup and restore

  1. Database and media backup helper

    Repository path: scripts/ops/backup.mjs

  2. Fresh-target restore helper

    Repository path: scripts/ops/restore.mjs

  3. Archive checksums and operations guards

    Repository path: scripts/ops/common.mjs

  4. Recovery policy and retention commands

    Repository path: docs/operations.md

  5. Paused worker behavior

    Repository path: apps/cms/src/worker/index.ts

  6. Full content and media recovery verification

    Repository path: docs/evidence/full-content-restore.json

  7. Measured dataset and capacity limits

    Repository path: docs/evidence/performance.md

  8. Audited retention and interrupted cleanup

    Repository path: scripts/ops/retention.ts

  9. PostgreSQL 18: SQL Dump

    Database snapshot, restore and role prerequisites; filesystem coordination is provided by the CMS helper.

  10. PostgreSQL official Docker image

    PostgreSQL 18 storage layout and initialization behavior.

Troubleshooting

  1. Structured CMS errors

    Repository path: apps/cms/src/cms/errors.ts

  2. Request errors and authenticated API boundary

    Repository path: apps/cms/src/cms/http.ts

  3. Local save state and conflict recovery

    Repository path: apps/cms/src/components/admin/resource-editor.tsx

  4. Draft and publication validation

    Repository path: apps/cms/src/cms/validation.ts

  5. Publication, preview and schedule rules

    Repository path: apps/cms/src/cms/services/content.ts

  6. Current role capabilities

    Repository path: apps/cms/src/cms/policy/index.ts

  7. Immutable media and access eligibility

    Repository path: apps/cms/src/cms/services/media.ts

  8. Published and preview content eligibility

    Repository path: apps/cms/src/cms/services/public.ts

  9. Worker process and health

    Repository path: apps/cms/src/worker/index.ts

  10. Retry and blocked-state handling

    Repository path: apps/cms/src/worker/handlers.ts

  11. Queue setup and retry configuration

    Repository path: apps/cms/src/cms/jobs/queue.ts

  12. Production runtime configuration

    Repository path: compose.yaml

  13. Local infrastructure configuration

    Repository path: compose.dev.yaml

  14. Migration failure and deployment behavior

    Repository path: scripts/ops/deploy.mjs

  15. Schema and media readiness checks

    Repository path: apps/cms/src/app/api/ready/route.ts

  16. Preserved existing local configuration

    Repository path: scripts/init-local.mjs

  17. Normal and stress workload evidence

    Repository path: docs/evidence/performance.md

  18. Operational diagnosis and recovery policy

    Repository path: docs/operations.md

  19. Current verification inventory

    Repository path: docs/build-status.md

  20. PostgreSQL official Docker image

    Initialization variables apply to an empty data directory; existing databases require deliberate credential changes.