flanker / chromadb-admin

Admin UI for Chroma embedding database built with Next.js

Hi there 👋

About me

FENG Zhichao (flanker).

My Blog https://fengzhichao.me

I work at Jinshuju (https://jinshuju.net).

我目前在 金数据 (https://jinshuju.net) 工作。

Social links

https://twitter.com/fengzhichao

https://www.youtube.com/channel/UCu0zYACLxbvEijvjntH36Lg

My stats

Join us!

https://jinshuju.net/f/bgohqz

chromadb-admin's Issues

Error on `npm install`

I am getting dependency errors on npm install. Any ideas?

╰─❯ npm install
npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR! 
npm ERR! While resolving: [email protected]
npm ERR! Found: [email protected]
npm ERR! node_modules/eslint
npm ERR!   dev eslint@"^9.1.1" from the root project
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peer eslint@"^8.56.0" from @typescript-eslint/[email protected]
npm ERR! node_modules/@typescript-eslint/parser
npm ERR!   dev @typescript-eslint/parser@"^7.7.1" from the root project
npm ERR!   peer @typescript-eslint/parser@"^7.0.0" from @typescript-eslint/[email protected]
npm ERR!   node_modules/@typescript-eslint/eslint-plugin
npm ERR!     dev @typescript-eslint/eslint-plugin@"^7.7.1" from the root project
npm ERR! 
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR! 
npm ERR! See /home/mj/.npm/eresolve-report.txt for a full report.

npm ERR! A complete log of this run can be found in:
npm ERR!     /home/mj/.npm/_logs/2024-05-02T03_37_13_677Z-debug-0.log

Push a stable docker image to DockerHub

Hi there :) Great project!

It'd be super cool if there'd be a stable, public image that I can use in my setup. I'm currently running ChromaDB in a docker-compose setup, and i want to add the admin UI as a separate container.

Right now I have to clone the repo and build the image myself.

Accept chroma credentials from environment variables, e.g.: ENV CHROMA_ADMIN_DATABASE_URL

For the dockerized version of this admin client it would be nice if we can predefine the credentials for the db within the docker compose file. Here would be the use case (see last line of code):

  chroma:
    image: chromadb/chroma:latest
    restart: always
    container_name: chroma
    networks:
      - internal_network
    healthcheck:
      test:
        [
          "CMD-SHELL",
          "curl -f localhost:8000/api/v1/heartbeat || exit 1"
        ]
      interval: 20s
      timeout: 30s
      retries: 5
    environment:
      CHROMA_SERVER_AUTH_CREDENTIALS: password
      CHROMA_SERVER_AUTH_CREDENTIALS_PROVIDER: chromadb.auth.token.TokenConfigServerAuthCredentialsProvider
      CHROMA_SERVER_AUTH_PROVIDER: chromadb.auth.token.TokenAuthServerProvider

  chroma-db-admin:
    image: fengzhichao/chromadb-admin
    container_name: chroma-db-admin
    depends_on:
      chroma:
        condition: service_healthy
    restart: always
    networks:
      - traefik_web
      - internal_network
    ports:
      - 3001:3000
    environment:
      CHROMA_ADMIN_DATABASE_URL: http://chroma:8000?authProvider=TokenAuthServerProvider&token=password

Setting this environment variable would then skip the login screen when visiting http://localhost:3001

Thanks in advance!

Add chroma authentication

I set up a chroma docker server, i would like to be able to use chromadb-admin with it. But since i added auth header and api to my chromadb, when i connect to it via chromadb-admin i get an unautherized error.

this is what i did for the auth:
to use X-Chroma-Token: test-token type of authentication header you can set an additional environment variable.

export CHROMA_SERVER_AUTH_CREDENTIALS="test-token"
export CHROMA_SERVER_AUTH_CREDENTIALS_PROVIDER="chromadb.auth.token.TokenConfigServerAuthCredentialsProvider"
export CHROMA_SERVER_AUTH_PROVIDER="chromadb.auth.token.TokenAuthServerProvider"
export CHROMA_SERVER_AUTH_TOKEN_TRANSPORT_HEADER="X_CHROMA_TOKEN"

from https://docs.trychroma.com/usage-guide

Add Support for Deleting Documents in Chroma DB UI

Description:
Currently, the Chroma DB UI allows users to view and manage documents, but it lacks the capability to delete documents directly from the UI. This feature is crucial for managing data lifecycle and ensuring that users can maintain their databases effectively without having to resort to external tools or direct database manipulation.

Expected Behavior:
The UI should provide a delete option for each document listed, enabling users to remove documents they no longer need. Ideally, this would involve:
Delete Button: Each document entry should have a delete button.
Confirmation Dialog: Clicking the delete button should open a confirmation dialog to prevent accidental deletions.
Real-time UI Update: After a document is successfully deleted, the UI should update to reflect this change without needing to reload the page.

Use Case:
As a user, I want to be able to delete documents from the Chroma DB UI so that I can manage my documents directly from the interface without needing backend access. This is particularly useful in scenarios where documents are outdated, incorrect, or no longer needed.