Skip to content

Commit

Permalink
update docker build instructions (#412)
Browse files Browse the repository at this point in the history
* update docker build instructions

* cleanup
  • Loading branch information
timothycarambat authored Dec 6, 2023
1 parent 88cdd8c commit 1a6f599
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 8 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,28 @@ This monorepo consists of three main sections:
- (optional) a vector database like Pinecone, qDrant, Weaviate, or Chroma*.
*AnythingLLM by default uses a built-in vector db called LanceDB.

## How to get started (Docker - simple setup)
## Recommended usage with Docker (easy!)
> [!TIP]
> It is best to mount the containers storage volume to a folder on your host machine
> so that you can pull in future updates without deleting your existing data!
`docker pull mintplexlabs/anythingllm:master`
`docker run -d -p 3001:3001 mintplexlabs/anythingllm:master`

Go to `http://localhost:3001` and you are now using AnythingLLm!
[More about running AnythingLLM with Docker](./docker/HOW_TO_USE_DOCKER.md)
```shell
STORAGE_LOCATION="/var/lib/anythingllm" \
mkdir "$STORAGE_LOCATION" && \
touch "$STORAGE_LOCATION/.env" && \
docker run -d -p 3001:3001 \
-v ${STORAGE_LOCATION}:/app/server/storage \
-v ${STORAGE_LOCATION}/.env:/app/server/.env \
-e STORAGE_DIR="/app/server/storage" \
mintplexlabs/anythingllm:master
```

Go to `http://localhost:3001` and you are now using AnythingLLM! All your data and progress will persist between
container rebuilds or pulls from Docker Hub.

[Learn more about running AnythingLLM with Docker](./docker/HOW_TO_USE_DOCKER.md)

### How to get started (Development environment)
- `yarn setup` from the project root directory.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@
"AnythingLLMInstanceSecurityGroup": {
"Type": "AWS::EC2::SecurityGroup",
"Properties": {
"GroupDescription": "AnythingLLm Instance Security Group",
"GroupDescription": "AnythingLLM Instance Security Group",
"SecurityGroupIngress": [
{
"IpProtocol": "tcp",
Expand Down
21 changes: 18 additions & 3 deletions docker/HOW_TO_USE_DOCKER.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,26 @@ Use the Dockerized version of AnythingLLM for a much faster and complete startup
## Requirements
- Install [Docker](https://www.docker.com/) on your computer or machine.

## Pull from Docker
## Recommend way to run dockerized AnythingLLM!
> [!TIP]
> It is best to mount the containers storage volume to a folder on your host machine
> so that you can pull in future updates without deleting your existing data!
`docker pull mintplexlabs/anythingllm:master`
`docker run -d -p 3001:3001 mintplexlabs/anythingllm:master`

Go to `http://localhost:3001` and you are now using AnythingLLm!
```shell
STORAGE_LOCATION="/var/lib/anythingllm" \
mkdir "$STORAGE_LOCATION" && \
touch "$STORAGE_LOCATION/.env" && \
docker run -d -p 3001:3001 \
-v ${STORAGE_LOCATION}:/app/server/storage \
-v ${STORAGE_LOCATION}/.env:/app/server/.env \
-e STORAGE_DIR="/app/server/storage" \
mintplexlabs/anythingllm:master
```

Go to `http://localhost:3001` and you are now using AnythingLLM! All your data and progress will persist between
container rebuilds or pulls from Docker Hub.

## Build locally from source
- `git clone` this repo and `cd anything-llm` to get to the root directory.
Expand Down

0 comments on commit 1a6f599

Please sign in to comment.