Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 2.21 KB

HOW_TO_USE_DOCKER.md

File metadata and controls

55 lines (37 loc) · 2.21 KB
Raw

How to use Dockerized Anything LLM

Use the Dockerized version of AnythingLLM for a much faster and complete startup of AnythingLLM.

Requirements

  • Install Docker on your computer or machine.

How to install

  • git clone this repo and cd anything-llm to get to the root directory.
  • cd docker/
  • cp .env.example .env to create the .env file.
  • Edit .env file and update the variables
  • docker-compose up -d --build to build the image - this will take a few moments.

Your docker host will show the image as online once the build process is completed. This will build the app to http://localhost:3001.

How to use the user interface

  • To access the full application, visit http://localhost:3001 in your browser.

How to add files to my system

  • Upload files from the UI in your Workspace settings

  • To run the collector scripts to grab external data (articles, URLs, etc.)

    • docker exec -it --workdir=/app/collector anything-llm python main.py

  • To run the collector watch script to process files from the hotdir

    • docker exec -it --workdir=/app/collector anything-llm python watch.py
    • Upload compliant files to ./collector/hotdir and they will be processed and made available in the UI.

How to update and rebuild the ENV?

  • Update the ./docker/.env and run docker-compose up -d --build to rebuild with new environments.

About UID and GID in the ENV

  • The UID and GID are set to 1000 by default. This is the default user in the Docker container and on most host operating systems. If there is a mismatch between your host user UID and GID and what is set in the .env file, you may experience permission issues.

⚠️ Vector DB support ⚠️

Out of the box, all vector databases are supported. Any vector databases requiring special configuration are listed below.

Using local ChromaDB with Dockerized AnythingLLM

  • Ensure in your ./docker/.env file that you have
#./docker/.env
...other configs

VECTOR_DB="chroma"
CHROMA_ENDPOINT='http://host.docker.internal:8000' # Allow docker to look on host port, not container.

...other configs

Still not working?

Ask for help on Discord