Skip to content

Commit

Permalink
chore: Collection note update on get_or_create behaviour
Browse files Browse the repository at this point in the history
- Added note for performance impacts of SSL termination in Chroma.
  • Loading branch information
tazarov committed Jun 26, 2024
1 parent 01f13af commit a1365a5
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/core/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ col = client.get_or_create_collection("test", metadata={"key": "value"})
!!! warn "Metadata with `get_or_create_collection()`"

If the collection exists and metadata is provided in the method it will attempt to overwrite the existing metadata.
This behaviour may be fixed by this [GH issue](https://github.com/chroma-core/chroma/issues/2390)

### Deleting a collection

Expand Down
6 changes: 6 additions & 0 deletions docs/security/chroma-ssl-cert.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ Chroma uses uvicorn as an ASGI server, which can be configured to use SSL/TLS ce

Using certificates with Chroma CLI is not yet supported.

??? tip "Performance Impact"

Using certificates within Chroma will have a performance impact as `uvicorn` will need to hnadle
the encryption and decryption of the data. If performance is of concern,
consider using a reverse proxy like `nginx` or `envoy` to handle the SSL/TLS termination.

## Self-Signed Certificates

### Creating a self-signed certificate
Expand Down

0 comments on commit a1365a5

Please sign in to comment.