Skip to content

docs: document LEANN_EMBEDDING_SERVER_HOST - #412

Merged
ASuresh0524 merged 1 commit into
mainfrom
docs/embedding-server-host
Sep 5, 2026
Merged

docs: document LEANN_EMBEDDING_SERVER_HOST#412
ASuresh0524 merged 1 commit into
mainfrom
docs/embedding-server-host

Conversation

@ASuresh0524

Copy link
Copy Markdown
Collaborator

Follow-up to #404.

That PR changed the HNSW and DiskANN embedding servers to bind 127.0.0.1 instead of tcp://*, and added LEANN_EMBEDDING_SERVER_HOST as the escape hatch. The variable was never documented — grep -rn LEANN_EMBEDDING_SERVER_HOST --include="*.md" returned nothing — so a container or cross-host deployment breaks on upgrade with no discoverable way to restore the previous behaviour.

Adds an Embedding Server Bind Address section to the configuration guide covering:

  • the loopback default and why it exists
  • how to widen it (0.0.0.0, a specific interface, IPv6 — brackets handled automatically by fix: bind ZMQ embedding servers to loopback by default #404)
  • that the ZMQ REP protocol is unauthenticated, so reachability is authorisation — widening it should be paired with a firewall or container-network restriction

Docs only, no code changes.

🤖 Generated with Claude Code

#404 changed the HNSW and DiskANN embedding servers to bind 127.0.0.1 instead
of every interface, and added LEANN_EMBEDDING_SERVER_HOST as the escape hatch.
The variable was never documented, so a container or cross-host deployment
breaks on upgrade with no discoverable way to restore the old behaviour.

Documents the default, the override, and why widening it deserves care — the
ZMQ REP protocol is unauthenticated, so reachability is authorisation.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@ASuresh0524
ASuresh0524 merged commit b1fbec8 into main Sep 5, 2026
3 checks passed
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