Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Chroma

Prerequisite

  1. Download & Install Docker and Git
  2. Clone Chroma's repository with your terminal
git clone https://github.com/chroma-core/chroma.git
  1. Change directory path to your cloned Chroma
cd chroma
  1. Run docker compose to build up Chroma image and container
docker compose up -d --build
  1. If success, you will be able to see the docker images spun up:

Setup

InputDescriptionDefault
DocumentCan be connected with nodes from Document Loader
EmbeddingsCan be connected with nodes from Embeddings
Collection NameChroma collection name. Refer to here for naming convention
Chroma URLSpecify the URL of your chroma instancehttp://localhost:8000

Additional

If you are running both aimicromind and Chroma on Docker, there are additional steps involved.

  1. Spin up Chroma docker first
docker compose up -d --build
  1. Open docker-compose.yml in AiMicromind
cd aimicromind&& cd docker
  1. Modify the file to:
version: '3.1'

services:
    aimicromind:
        image: aimicromind/aimicromind 
        restart: always
        environment:
            - PORT=${PORT}
            - AIMICROMIND_USERNAME=${AIMICROMIND_USERNAME}
            - AIMICROMIND_PASSWORD=${AIMICROMIND_PASSWORD}
            - DEBUG=${DEBUG}
            - DATABASE_PATH=${DATABASE_PATH}
            - APIKEY_PATH=${APIKEY_PATH}
            - SECRETKEY_PATH=${SECRETKEY_PATH}
            - AIMICROMIND_SECRETKEY_OVERWRITE=${AIMICROMIND_SECRETKEY_OVERWRITE}
            - LOG_PATH=${LOG_PATH}
            - LOG_LEVEL=${LOG_LEVEL}
            - EXECUTION_MODE=${EXECUTION_MODE}
        ports:
            - '${PORT}:${PORT}'
        volumes:
            - ~/.aimicromind:/root/.aimicromind
        networks:
            - aimicromind_net
        command: /bin/sh -c "sleep 3; aimicromind start"
networks:
    aimicromind_net:
        name: chroma_net
        external: true
  1. Spin up aimicromind docker image
docker compose up -d
  1. On the Chroma URL, for Windows and MacOS Operating Systems specify http://host.docker.internal:8000. For Linux based systems the default docker gateway should be used since host.docker.internal is not available: http://172.17.0.1:8000

Resources