Skip to content

docs: add host and port documentation for Docker#142

Closed
rieger-jared wants to merge 1 commit intoDavidyz:mainfrom
rieger-jared:add-docker-docs
Closed

docs: add host and port documentation for Docker#142
rieger-jared wants to merge 1 commit intoDavidyz:mainfrom
rieger-jared:add-docker-docs

Conversation

@rieger-jared
Copy link

I ran into a bug where VectorCode wouldn’t connect to my ChromaDB Docker instance and kept starting its own server, even though my Docker container was up and reachable. After some digging, I realized the problem was that I had set "host": "http://127.0.0.1" in my config, but VectorCode expects just "127.0.0.1" (no http://). Including the protocol breaks the connection check.

This PR updates the docs to make it super clear:

  • The host value should not include http:// or https://—just use the hostname or IP.
  • Added a clear “do this / don’t do this” example in the Docker section.
  • Added warnings and cross-links wherever host/port or Docker setup is mentioned.

Hopefully this saves others the same headache!

Reference: issue #140

@codecov
Copy link

codecov bot commented May 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.24%. Comparing base (d899df3) to head (6d7c10e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #142   +/-   ##
=======================================
  Coverage   99.24%   99.24%           
=======================================
  Files          22       22           
  Lines        1457     1457           
=======================================
  Hits         1446     1446           
  Misses         11       11           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Davidyz Davidyz added the documentation Improvements or additions to documentation label May 15, 2025
Copy link
Owner

@Davidyz Davidyz left a comment

Choose a reason for hiding this comment

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

Thanks for this! One thing that I'd suggest is that this doesn't only apply to docker containers. It's possible to deploy standalone chromadb via other daemon services, such as systemd. I'd suggest a change in the wording so that it's clear that it applies to all users who deploy standalone servers, not just dockers.

Otherwise LGTM!

@Davidyz
Copy link
Owner

Davidyz commented May 15, 2025

I'm closing this PR in favour of #143 , which provides more flexibility in how the chroma endpoint is set up.

@rieger-jared, thanks for spotting this problem and preparing this PR anyway!

@Davidyz Davidyz closed this May 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants