You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

28 lines
875 B

11 months ago
  1. # How to setup a local (or remote) Chroma Vector Database
  2. [Official Chroma Docs](https://docs.trychroma.com/guides#running-chroma-in-clientserver-mode) for reference.
  3. ### How to get started
  4. **Requirements**
  5. - Docker
  6. - `git` available in your CLI/terminal
  7. **Instructions**
  8. - `git clone git@github.com:chroma-core/chroma.git` to somewhere on computer.
  9. - `cd chroma`
  10. - `docker-compose up -d --build`
  11. - set the `CHROMA_ENDPOINT=` .env variable in `server` and also set `VECTOR_DB=` to `chroma`.
  12. * If you have an API Gateway or auth middleway be sure to set the `CHROMA_API_HEADER` and `CHROMA_API_KEY` keys.
  13. eg: `server/.env.development`
  14. ```
  15. VECTOR_DB="chroma"
  16. CHROMA_ENDPOINT='http://localhost:8000'
  17. # CHROMA_API_HEADER="X-Api-Key" // If you have an Auth middleware on your instance.
  18. # CHROMA_API_KEY="sk-123abc" // If you have an Auth middleware on your instance.
  19. ```