From 4072369f44a68f1cdc42bc0549f5c61d9de09fcf Mon Sep 17 00:00:00 2001 From: frasergr <frasergr@users.noreply.github.com> Date: Sat, 17 Jun 2023 20:19:34 -0700 Subject: [PATCH] updated instructions in docker readme (#79) --- docker/HOW_TO_USE_DOCKER.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/docker/HOW_TO_USE_DOCKER.md b/docker/HOW_TO_USE_DOCKER.md index 9641ab6cf..6a429ba2d 100644 --- a/docker/HOW_TO_USE_DOCKER.md +++ b/docker/HOW_TO_USE_DOCKER.md @@ -7,8 +7,9 @@ Use the Dockerized version of AnythingLLM for a much faster and complete startup ## How to install - `git clone` this repo and `cd anything-llm` to get to the root directory. -- `yarn setup:envs` from repo root & fill out the `.env` file that is then created in `./docker/` - `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`. @@ -17,16 +18,20 @@ Your docker host will show the image as online once the build process is complet - 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 on local documents you want to provide to it +- 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](../collector/hotdir/__HOTDIR__.md) 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. -- GitLab