Config Reference Map the major GraphJin configuration areas to focused guides and canonical source docs. reference reference reference/config-reference reference/config-reference.md

Config Reference

Map the major GraphJin configuration areas to focused guides and canonical source docs.

Major sections

AreaGuide
Sources modeSources Mode
Database configDatabase Config
Auth and RBACAuth And RBAC
Caching and RedisCaching And Redis
Uploads and filesystemsUploads And Filesystems
OpenAPIOpenAPI Config
Environment and productionEnvironment And Production
MCPMCP and MCP OAuth
FederationApollo Federation

Canonical source

The full field-by-field reference remains in CONFIG.md. This site turns that file into a progressive reading path but does not replace the checked-in reference.

Common source-mode skeleton

YAML
mode: agentic

identity:
  user_id_claim: sub
  namespace_claim: account_id
  role_claims: [role, roles]

sources:
  - name: app
    kind: database
    type: postgres
    default: true
    connection_string: ${DATABASE_URL}
    access:
      read: account
      write: blocked
      delete: blocked

  - name: graphjin
    kind: graphjin
    catalog: true
    metadata: true
    access:
      roots:
        gj_catalog: authenticated
        gj_security: admin
        gj_runtime: admin

Verified by TestConfigDocsTemplatesUseSources serv/mcp_config_docs_test.go:8
Verified by TestAgenticConfigDocsTemplate serv/mcp_config_docs_test.go:27

Validation surfaces

ChangeTests to look near
New source capabilitycore/sourcecap, catalog, security, MCP registration, and source access tests
New config fieldconfig decode/validation tests plus MCP config docs tests
New API or file providersource-mode normalization and runtime init tests
New security defaultgj_security, config scan, and caller capability profile tests

Validation

Configuration changes should be validated through the existing config and subsystem tests, especially when adding source capabilities, MCP settings, OpenAPI fields, or security defaults.

Docs