2023-06-08 06:31:35 +02:00
|
|
|
# How to setup a local (or remote) Chroma Vector Database
|
|
|
|
|
|
|
|
|
|
[Official Chroma Docs](https://docs.trychroma.com/usage-guide#running-chroma-in-clientserver-mode) for reference.
|
|
|
|
|
|
|
|
|
|
### How to get started
|
|
|
|
|
|
|
|
|
|
**Requirements**
|
|
|
|
|
|
|
|
|
|
- Docker
|
|
|
|
|
- `git` available in your CLI/terminal
|
|
|
|
|
|
|
|
|
|
**Instructions**
|
|
|
|
|
|
|
|
|
|
- `git clone git@github.com:chroma-core/chroma.git` to somewhere on computer.
|
|
|
|
|
- `cd chroma`
|
|
|
|
|
- `docker-compose up -d --build`
|
|
|
|
|
- set the `CHROMA_ENDPOINT=` .env variable in `server` and also set `VECTOR_DB=` to `chroma`.
|
|
|
|
|
|
2023-09-29 22:20:06 +02:00
|
|
|
* If you have an API Gateway or auth middleway be sure to set the `CHROMA_API_HEADER` and `CHROMA_API_KEY` keys.
|
|
|
|
|
|
2023-06-08 06:31:35 +02:00
|
|
|
eg: `server/.env.development`
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
VECTOR_DB="chroma"
|
|
|
|
|
CHROMA_ENDPOINT='http://localhost:8000'
|
2023-09-29 22:20:06 +02:00
|
|
|
# CHROMA_API_HEADER="X-Api-Key" // If you have an Auth middleware on your instance.
|
|
|
|
|
# CHROMA_API_KEY="sk-123abc" // If you have an Auth middleware on your instance.
|
2023-06-08 06:31:35 +02:00
|
|
|
```
|
