Skip to content
Snippets Groups Projects
Commit e114a90a authored by timothycarambat's avatar timothycarambat
Browse files

update package scripts

update ignore for legacy repo copies
add docker instructions and use
parent 9f33b3df
No related branches found
No related tags found
Loading
# How to use Dockerized Anything LLM
Use the Dockerized version of AnythingLLM for a much faster and complete startup of AnythingLLM.
## Requirements
- Install [Docker](https://www.docker.com/) on your computer or machine.
## 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/`
- `docker-compose up -d --build` to build the image - this will take a few moments.
Your docker host will show the image as online one 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
- 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
- `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.
## ⚠️ 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](https://discord.gg/6UyHPeGZAC)
......@@ -11,7 +11,7 @@
"scripts": {
"lint": "cd server && yarn lint && cd .. && cd frontend && yarn lint",
"setup": "cd server && yarn && cd ../frontend && yarn && cd .. && yarn setup:envs && echo \"Please run yarn dev:server and yarn dev:frontend in separate terminal tabs.\"",
"setup:envs": "cd server && cp -n .env.example .env.development && cd ../collector && cp -n .env.example .env && cd ..",
"setup:envs": "cp -n ./server/.env.example ./server/.env.development && cp -n ./collector/.env.example ./collector/.env && cp -n ./docker/.env.example ./docker/.env && echo \"All ENV files copied!\n\"",
"dev:server": "cd server && yarn dev",
"dev:frontend": "cd frontend && yarn start",
"prod:server": "cd server && yarn start",
......
......@@ -6,4 +6,8 @@ storage/vector-cache/*.json
logs/server.log
*.db
storage/lancedb
public/
\ No newline at end of file
public/
# For legacy copies of repo
documents
vector-cache
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment