update

.dockerignore

@@ -1,3 +1,4 @@
+**/server/utils/agents/aibitat/example/**
 **/server/storage/documents/**
 **/server/storage/vector-cache/**
 **/server/storage/*.db

.github/ISSUE_TEMPLATE/01_bug.yml

@@ -5,11 +5,8 @@ labels: [possible bug]
 body:
   - type: markdown
     attributes:
-      value: |
-      Use this template to file a bug report for AnythingLLM. Please be as descriptive as possible to allow everyone to replicate and solve your issue.
-
-      Want help contributing a PR? Use our repo chatbot by OnboardAI! https://app.getonboardai.com/chat/github/mintplex-labs/anything-llm
-
+      value: | 
+        Use this template to file a bug report for AnythingLLM. Please be as descriptive as possible to allow everyone to replicate and solve your issue. Want help contributing a PR? Use our repo chatbot by OnboardAI! https://learnthisrepo.com/anythingllm"
   - type: dropdown
     id: runtime
     attributes:
@@ -20,6 +17,7 @@ body:
         - Docker (remote machine)
         - Local development
         - AnythingLLM desktop app
+        - All versions
         - Not listed
       default: 0
     validations:

.github/ISSUE_TEMPLATE/02_feature.yml

@@ -9,7 +9,7 @@ body:
         Share a new idea for a feature or improvement. Be sure to search existing
         issues first to avoid duplicates.
 
-        Want help contributing a PR? Use our repo chatbot by OnboardAI! https://app.getonboardai.com/chat/github/mintplex-labs/anything-llm
+        Want help contributing a PR? Use our repo chatbot by OnboardAI! https://learnthisrepo.com/anythingllm
 
 
   - type: textarea

.github/workflows/build-and-push-image.yaml

@@ -1,6 +1,6 @@
 # This Github action is for publishing of the primary image for AnythingLLM
 # It will publish a linux/amd64 and linux/arm64 image at the same time
-# This file should ONLY BY USED FOR `master` BRANCH. 
+# This file should ONLY BY USED FOR `master` BRANCH.
 # TODO: Update `runs-on` for arm64 when GitHub finally supports
 # native arm environments as QEMU takes around 1 hour to build
 # ref: https://github.com/actions/runner-images/issues/5631 :(
@@ -20,6 +20,8 @@ on:
       - '.vscode/**/*'
       - '**/.env.example'
       - '.github/ISSUE_TEMPLATE/**/*'
+      - 'embed/**/*' # Embed should be published to frontend (yarn build:publish) if any changes are introduced
+      - 'server/utils/agents/aibitat/example/**/*' # Do not push new image for local dev testing of new aibitat images.
 
 jobs:
   push_multi_platform_to_registries:
@@ -32,11 +34,11 @@ jobs:
       - name: Check out the repo
         uses: actions/checkout@v4
 
-      - name: Parse repository name to lowercase
+      - name: Check if DockerHub build needed
         shell: bash
         run: echo "repo=${GITHUB_REPOSITORY,,}" >> $GITHUB_OUTPUT
         id: lowercase_repo
-      
+
       - name: Check if DockerHub build needed
         shell: bash
         run: |
@@ -55,22 +57,22 @@ jobs:
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
-      
+
       - name: Log in to Docker Hub
         uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
         # Only login to the Docker Hub if the repo is mintplex/anythingllm, to allow for forks to build on GHCR
-        if: steps.dockerhub.outputs.enabled == 'true' 
+        if: steps.dockerhub.outputs.enabled == 'true'
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
-      
+
       - name: Log in to the Container registry
         uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
         with:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
-      
+
       - name: Extract metadata (tags, labels) for Docker
         id: meta
         uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7

.hadolint.yaml

@@ -0,0 +1,8 @@
+failure-threshold: warning
+ignored:
+  - DL3008
+  - DL3013
+format: tty
+trustedRegistries:
+  - docker.io
+  - gcr.io

.vscode/settings.json

@@ -1,11 +1,43 @@
 {
   "cSpell.words": [
+    "adoc",
+    "aibitat",
+    "AIbitat",
+    "anythingllm",
+    "Astra",
+    "Chartable",
+    "comkey",
+    "cooldown",
+    "cooldowns",
+    "Deduplicator",
     "Dockerized",
+    "Embeddable",
+    "epub",
+    "GROQ",
+    "hljs",
+    "huggingface",
+    "inferencing",
+    "koboldcpp",
     "Langchain",
+    "lmstudio",
+    "localai",
+    "mbox",
+    "Milvus",
+    "Mintplex",
+    "moderations",
     "Ollama",
+    "Oobabooga",
     "openai",
+    "opendocument",
+    "openrouter",
     "Qdrant",
-    "Weaviate"
+    "Serper",
+    "textgenwebui",
+    "togetherai",
+    "vectordbs",
+    "Weaviate",
+    "Zilliz"
   ],
-  "eslint.experimental.useFlatConfig": true
+  "eslint.experimental.useFlatConfig": true,
+  "docker.languageserver.formatter.ignoreMultilineInstructions": true
 }

BARE_METAL.md

@@ -0,0 +1,118 @@
+# Run AnythingLLM in production without Docker
+
+> [!WARNING]
+> This method of deployment is **not supported** by the core-team and is to be used as a reference for your deployment.
+> You are fully responsible for securing your deployment and data in this mode.
+> **Any issues** experienced from bare-metal or non-containerized deployments will be **not** answered or supported.
+
+Here you can find the scripts and known working process to run AnythingLLM outside of a Docker container. This method of deployment is preferable for those using local LLMs and want native performance on their devices.
+
+### Minimum Requirements
+> [!TIP]
+> You should aim for at least 2GB of RAM. Disk storage is proportional to however much data
+> you will be storing (documents, vectors, models, etc). Minimum 10GB recommended.
+
+- NodeJS v18
+- Yarn
+
+
+## Getting started
+
+1. Clone the repo into your server as the user who the application will run as.
+`git clone git@github.com:Mintplex-Labs/anything-llm.git`
+
+2. `cd anything-llm` and run `yarn setup`. This will install all dependencies to run in production as well as debug the application.
+
+3. `cp server/.env.example server/.env` to create the basic ENV file for where instance settings will be read from on service start.
+
+4. Ensure that the `server/.env` file has _at least_ these keys to start. These values will persist and this file will be automatically written and managed after your first successful boot.
+```
+STORAGE_DIR="/your/absolute/path/to/server/storage"
+```
+
+5. Edit the `frontend/.env` file for the `VITE_BASE_API` to now be set to `/api`. This is documented in the .env for which one you should use.
+```
+# VITE_API_BASE='http://localhost:3001/api' # Use this URL when developing locally
+# VITE_API_BASE="https://$CODESPACE_NAME-3001.$GITHUB_CODESPACES_PORT_FORWARDING_DOMAIN/api" # for Github Codespaces
+VITE_API_BASE='/api' # Use this URL deploying on non-localhost address OR in docker.
+```
+
+## To start the application
+
+AnythingLLM is comprised of three main sections. The `frontend`, `server`, and `collector`. When running in production you will be running `server` and `collector` on two different processes, with a build step for compilation of the frontend.
+
+1. Build the frontend application.
+`cd frontend && yarn build` - this will produce a `frontend/dist` folder that will be used later.
+
+2. Copy `frontend/dist` to `server/public` - `cp -R frontend/dist server/public`.
+This should create a folder in `server` named `public` which contains a top level `index.html` file and various other files/folders.
+
+_(optional)_ Build native LLM support if using `native` as your LLM.
+`cd server && npx --no node-llama-cpp download`
+
+3. Migrate and prepare your database file.
+```
+cd server && npx prisma generate --schema=./prisma/schema.prisma
+cd server && npx prisma migrate deploy --schema=./prisma/schema.prisma
+```
+
+4. Boot the server in production
+`cd server && NODE_ENV=production node index.js &` 
+
+5. Boot the collection in another process
+`cd collector && NODE_ENV=production node index.js &` 
+
+AnythingLLM should now be running on `http://localhost:3001`!
+
+## Updating AnythingLLM
+
+To update AnythingLLM with future updates you can `git pull origin master` to pull in the latest code and then repeat steps 2 - 5 to deploy with all changes fully.
+
+_note_ You should ensure that each folder runs `yarn` again to ensure packages are up to date in case any dependencies were added, changed, or removed.
+
+_note_ You should `pkill node` before running an update so that you are not running multiple AnythingLLM processes on the same instance as this can cause conflicts.
+
+
+### Example update script
+
+```shell
+#!/bin/bash
+
+cd $HOME/anything-llm &&\
+git checkout . &&\
+git pull origin master &&\
+echo "HEAD pulled to commit $(git log -1 --pretty=format:"%h" | tail -n 1)"
+
+echo "Freezing current ENVs"
+curl -I "http://localhost:3001/api/env-dump" | head -n 1|cut -d$' ' -f2
+
+echo "Rebuilding Frontend"
+cd $HOME/anything-llm/frontend && yarn && yarn build && cd $HOME/anything-llm
+
+echo "Copying to Sever Public"
+rm -rf server/public
+cp -r frontend/dist server/public
+
+echo "Killing node processes"
+pkill node
+
+echo "Installing collector dependencies"
+cd $HOME/anything-llm/collector && yarn
+
+echo "Installing server dependencies & running migrations"
+cd $HOME/anything-llm/server && yarn
+cd $HOME/anything-llm/server && npx prisma migrate deploy --schema=./prisma/schema.prisma
+cd $HOME/anything-llm/server && npx prisma generate
+
+echo "Booting up services."
+truncate -s 0 /logs/server.log # Or any other log file location.
+truncate -s 0 /logs/collector.log
+
+cd $HOME/anything-llm/server
+(NODE_ENV=production node index.js) &> /logs/server.log &
+
+cd $HOME/anything-llm/collector
+(NODE_ENV=production node index.js) &> /logs/collector.log &
+```
+
+