Skip to content
This repository was archived by the owner on May 10, 2024. It is now read-only.

Update instructions to use pre-built docker images #79

Closed
buddhikajay wants to merge 2 commits into from
Closed

Update instructions to use pre-built docker images #79

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b79e6d9
Update instructions to use pre-built docker images
buddhikajay Jun 7, 2023
65c61f3
Updated clickouse deps
buddhikajay Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,20 +59,28 @@ const {ChromaClient} = require('chromadb');
const client = new ChromaClient();
```

To connect to Chroma's backend - you either need to connect to a hosted version of Chroma, or run it on your local computer. If you can run `docker-compose up -d --build` you can run Chroma.
</TabItem>

</Tabs>

To connect to Chroma's backend - you either need to connect to a hosted version of Chroma, or run it on your local computer.
Copy link
Contributor

@jeffchuber jeffchuber Jun 7, 2023

Choose a reason for hiding this comment

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

This should be inside the tab for javascript since this is not true for python

Copy link
Contributor

@jeffchuber jeffchuber Jun 7, 2023

Choose a reason for hiding this comment

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

whoops - meant to mark this as Request Changes cc @buddhikajay

Copy link
Author

@buddhikajay buddhikajay Jun 8, 2023

Choose a reason for hiding this comment

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

Cool. I'll get this sorted

Copy link
Contributor

@jeffchuber jeffchuber Jun 21, 2023

Choose a reason for hiding this comment

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

@buddhikajay any update here? would love to get this merged in! let me know if you want me to take over the branch

You can pull pre-built image using

```bash
docker pull ghcr.io/chroma-core/chroma:latest
```

or you can build the container from source using

```bash
git clone https://github.com/chroma-core/chroma.git
cd chroma
docker-compose up -d --build
```

Refer to [this docker-compose file](https://github.com/chroma-core/chroma/blob/main/docker-compose.yml) for environment variables and other dependencies (eg: [clickhouse](https://clickhouse.com)).
If you have build issues, please reach out for help in the active [Community Discord](https://discord.gg/MMeYNTmh3x). Most issues get fixed in a few minutes.

</TabItem>

</Tabs>

### 3. Create a collection

Collections are where you'll store your embeddings, documents, and any additional metadata. You can create a collection with a name:
Expand Down