You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/running/running-chroma.md
+22-11
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,8 @@ pip install chromadb
19
19
chroma run --host localhost --port 8000 --path ./my_chroma_data
20
20
```
21
21
22
-
`--host` The host to which to listen to, by default it is `[localhost](http://localhost:8000/docs)` , but if you want to expose it to your entire network then you can specify `0.0.0.0``
22
+
`--host` The host to which to listen to, by default it is `[localhost](http://localhost:8000/docs)` , but if you want to
23
+
expose it to your entire network then you can specify `0.0.0.0``
23
24
24
25
`--port` The port on which to listen to, by default this is `8000`.
-`-v` specifies a local dir which is where Chroma will store its data so when the container is destroyed the data remains
43
+
-`-v` specifies a local dir which is where Chroma will store its data so when the container is destroyed the data
44
+
remains. Note: If you are using `-e PERSIST_DIRECTORY` then you need to point the volume to that directory.
43
45
-`-e``IS_PERSISTENT=TRUE` let’s Chroma know to persist data
44
-
-`-e ANONYMIZED_TELEMETRY=TRUE` allows you to turn on (`TRUE`) or off (`FALSE`) anonymous product telemetry which helps the Chroma team in making informed decisions about Chroma OSS and commercial direction.
45
-
-`chromadb/chroma:latest` indicates the latest Chroma version but can be replaced with any valid tag if a prior version is needed (e.g. `chroma:0.4.18`)
46
+
-`-e``PERSIST_DIRECTORY=/path/in/container` specifies the path in the container where the data will be stored, by
47
+
default it is `/chroma/chroma`
48
+
-`-e ANONYMIZED_TELEMETRY=TRUE` allows you to turn on (`TRUE`) or off (`FALSE`) anonymous product telemetry which helps
49
+
the Chroma team in making informed decisions about Chroma OSS and commercial direction.
50
+
-`chromadb/chroma:latest` indicates the latest Chroma version but can be replaced with any valid tag if a prior version
51
+
is needed (e.g. `chroma:0.4.24`)
46
52
47
53
### Docker Compose (Cloned Repo)
48
54
49
-
If you are feeling adventurous you can also use the Chroma `main` branch to run a local Chroma server with the latest changes:
55
+
If you are feeling adventurous you can also use the Chroma `main` branch to run a local Chroma server with the latest
56
+
changes:
50
57
51
58
Prerequisites:
52
59
@@ -61,12 +68,13 @@ docker compose up -d --build
61
68
If you want to run a specific version of Chroma you can checkout the version tag you need:
62
69
63
70
```shell
64
-
git checkout release/0.4.20
71
+
git checkout release/0.4.24
65
72
```
66
73
67
74
### Docker Compose (Without Cloning the Repo)
68
75
69
-
If you do not wish or are able to clone the repo locally, Chroma server can also be run with docker compose by creating (or using a gist) a `docker-compose.yaml`
76
+
If you do not wish or are able to clone the repo locally, Chroma server can also be run with docker compose by
77
+
creating (or using a gist) a `docker-compose.yaml`
70
78
71
79
Prerequisites:
72
80
@@ -86,14 +94,16 @@ services:
86
94
- ./chromadb:/chroma/chroma
87
95
environment:
88
96
- IS_PERSISTENT=TRUE
97
+
- PERSIST_DIRECTORY=/chroma/chroma # this is the default path, change it as needed
The above will create a container with the latest Chroma (`chromadb/chroma:latest`), will expose it to port `8000` on the local machine and will persist data in `./chromadb` relative path from where the `docker-compose.yaml` has been ran.
105
+
The above will create a container with the latest Chroma (`chromadb/chroma:latest`), will expose it to port `8000` on
106
+
the local machine and will persist data in `./chromadb` relative path from where the `docker-compose.yaml` has been ran.
97
107
98
108
We have also created a small gist with the above file for convenience:
0 commit comments