kamp/anything-llm
1
0
Fork 0
mirror of https://github.com/Mintplex-Labs/anything-llm.git synced 2024-10-05 18:30:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

updated instructions in docker readme (#79)

Browse Source
This commit is contained in:
frasergr 2023-06-17 20:19:34 -07:00 committed by GitHub
parent 4079020de0
commit 4072369f44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docker/HOW_TO_USE_DOCKER.md
View File

@ -7,8 +7,9 @@ Use the Dockerized version of AnythingLLM for a much faster and complete startup
## How to install ## How to install
- `git clone` this repo and `cd anything-llm` to get to the root directory. - `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/` - `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. - `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`. 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. - To access the full application, visit `http://localhost:3001` in your browser.
## How to add files to my system ## 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.) - To run the collector scripts to grab external data (articles, URLs, etc.)
- `docker exec -it --workdir=/app/collector anything-llm python main.py` - `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` - `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. - 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? ## How to update and rebuild the ENV?
- Update the `./docker/.env` and run `docker-compose up -d --build` to rebuild with new environments. - 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 ⚠️ ## ⚠️ Vector DB support ⚠️
Out of the box, all vector databases are supported. Any vector databases requiring special configuration are listed below. Out of the box, all vector databases are supported. Any vector databases requiring special configuration are listed below.