Skip to content

Add deployment guidance for self-hosted Gremlin Server - #2381

Merged
kmcginnes merged 1 commit into
mainfrom
gremlin-server-script-engine-guidance
Oct 7, 2026
Merged

kmcginnes merged 1 commit into
mainfrom
gremlin-server-script-engine-guidance

Conversation

@kmcginnes

Copy link
Copy Markdown
Collaborator

Summary

Our security reference explains that Graph Explorer performs no authentication, but it said nothing about the script engine the connected database runs. A deployer pointing Graph Explorer at a self-hosted Gremlin Server had no guidance on what the default Groovy engine means for who should be able to reach the app.

docs/
├── references/security.md                   # new: Self-hosted Gremlin Server
├── guides/connecting-to-gremlin-server.md   # local-development warning
└── getting-started/README.md                # corrected network claim
samples/air_routes/
├── README.md                                # names the script engine
├── docker-compose.yaml                      # app published on loopback
└── sample/conf/gremlin-server-air-routes.yaml

The new section states TinkerPop's documented position, points at their own server-side configuration docs, and notes that Amazon Neptune doesn't use Groovy. It stops short of recommending the gremlin-lang engine, because Graph Explorer can't talk to a server configured that way yet (#2379).

Evidence

Before: the security reference covered access control but not the database's script engine, and the getting-started note claimed the sample serves Graph Explorer on every network interface.
After: the reference has a Self-hosted Gremlin Server section, the Gremlin Server guide and the sample both link to it, and the getting-started note matches what the Compose file does.

Verified live: the air routes sample on Gremlin Server 3.8.2, loading 3749 vertices and 57645 edges. Schema sync through the UI, with the app reachable only on loopback.

Merge Danger

Door: two-way

Impact: sample reachability

The Compose file now publishes Graph Explorer on 127.0.0.1 instead of every interface. Anyone who reached the sample from another machine needs to change that binding back or tunnel to it.

Related

@kmcginnes kmcginnes left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved

@kmcginnes
kmcginnes merged commit eb9e32b into main Oct 7, 2026
3 checks passed
@kmcginnes
kmcginnes deleted the gremlin-server-script-engine-guidance branch October 7, 2026 20:04
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.

1 participant