Skip to content

docs: document graph backend configuration - #283

Open
erenbati wants to merge 1 commit into
guacsec:mainfrom
erenbati:docs/backend-flags-278
Open

erenbati wants to merge 1 commit into
guacsec:mainfrom
erenbati:docs/backend-flags-278

Conversation

@erenbati

@erenbati erenbati commented Oct 5, 2026

Copy link
Copy Markdown
Contributor

Fixes #278

Summary

  • Document the graph backends registered by guacgql and how to select them with gql-backend.
  • Document the keyvalue backend options, including kv-store, Redis, and TiKV configuration.
  • Clarify that the default memmap store is in-memory and does not persist graph data across guacgql restarts.
  • Document the ArangoDB, Neo4j, and Neptune backend-specific configuration options and their relevant defaults.
  • Update the configuration defaults table to distinguish demo guac.yaml values from binary defaults.

Validation

  • npx --yes prettier --check --prose-wrap always ./**/*.md
  • Passed in GitHub Actions on the fork.

Signed-off-by: Eren Batı <243848222+erenbati@users.noreply.github.com>
@netlify

netlify Bot commented Oct 5, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for resonant-wisp-1a517a ready!

Name Link
🔨 Latest commit 616cdd9
🔍 Latest deploy log https://app.netlify.com/projects/resonant-wisp-1a517a/deploys/6ac3e6c31f91290008be82d6
😎 Deploy Preview https://deploy-preview-283--resonant-wisp-1a517a.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document backend-specific flags (--kv-store, Arango, Neo4j, Neptune)

1 participant