kotaemon

Installation

If you are not a developer and just want to use the app, please check out our easy-to-follow User Guide. Download the .zip file from the latest release to get all the newest features and bug fixes.

System requirements

1. Python >= 3.10
2. Docker: optional, if you install with Docker
3. Unstructured if you want to process files other than .pdf, .html, .mhtml, and .xlsx documents. Installation steps differ depending on your operating system. Please visit the link and follow the specific instructions provided there.

With Docker (recommended)

1. We support both lite & full version of Docker images. With full version, the extra packages of unstructured will be installed, which can support additional file types (.doc, .docx, ...) but the cost is larger docker image size. For most users, the lite image should work well in most cases.

   • To use the full version.

     docker run \
     -e GRADIO_SERVER_NAME=0.0.0.0 \
     -e GRADIO_SERVER_PORT=7860 \
     -v ./ktem_app_data:/app/ktem_app_data \
     -p 7860:7860 -it --rm \
     ghcr.io/cinnamon/kotaemon:main-full
     

   • To use the full version with bundled Ollama for local / private RAG.

     # change image name to
     docker run <...> ghcr.io/cinnamon/kotaemon:main-ollama
     

   • To use the lite version.

    # change image name to
    docker run <...> ghcr.io/cinnamon/kotaemon:main-lite
   

2. We currently support and test two platforms: linux/amd64 and linux/arm64 (for newer Mac). You can specify the platform by passing --platform in the docker run command. For example:

   # To run docker with platform linux/arm64
   docker run \
   -e GRADIO_SERVER_NAME=0.0.0.0 \
   -e GRADIO_SERVER_PORT=7860 \
   -v ./ktem_app_data:/app/ktem_app_data \
   -p 7860:7860 -it --rm \
   --platform linux/arm64 \
   ghcr.io/cinnamon/kotaemon:main-lite
   

3. Once everything is set up correctly, you can go to http://localhost:7860/ to access the WebUI.

4. We use GHCR to store docker images, all images can be found here.

Without Docker

1. Clone the repository:

   git clone https://github.com/Cinnamon/kotaemon
   cd kotaemon
   

2. Setup the environment:

• Option 1: Using uv (recommended)

  uv sync --python 3.10
  source .venv/bin/activate
  

• Option 2: Using conda

  conda create -n kotaemon python=3.10
  conda activate kotaemon
  
  pip install -e "libs/kotaemon[all]"
  pip install -e "libs/ktem"
  

3. Create a .env file in the root of this project. Use .env.example as a template.

   The .env file is there to serve use cases where users want to pre-config the models before starting up the app (e.g. deploy the app on HF hub). The file will only be used to populate the db once upon the first run, it will no longer be used in consequent runs.

4. (Optional) To enable in-browser PDF_JS viewer, download PDF_JS_DIST then extract it to libs/ktem/ktem/assets/prebuilt.

   

5. Start the web server:

   python app.py
   

   • The app will be automatically launched in your browser.
   • Default username and password are both admin. Y