mirror of
https://github.com/Mintplex-Labs/anything-llm.git
synced 2024-10-01 08:20:27 +02:00
update docker build instructions (#412)
* update docker build instructions * cleanup
This commit is contained in:
parent
88cdd8c872
commit
1a6f599971
26
README.md
26
README.md
@ -78,12 +78,28 @@ This monorepo consists of three main sections:
|
|||||||
- (optional) a vector database like Pinecone, qDrant, Weaviate, or Chroma*.
|
- (optional) a vector database like Pinecone, qDrant, Weaviate, or Chroma*.
|
||||||
*AnythingLLM by default uses a built-in vector db called LanceDB.
|
*AnythingLLM by default uses a built-in vector db called LanceDB.
|
||||||
|
|
||||||
## How to get started (Docker - simple setup)
|
## Recommended usage with Docker (easy!)
|
||||||
`docker pull mintplexlabs/anythingllm:master`
|
> [!TIP]
|
||||||
`docker run -d -p 3001:3001 mintplexlabs/anythingllm:master`
|
> 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!
|
||||||
|
|
||||||
Go to `http://localhost:3001` and you are now using AnythingLLm!
|
`docker pull mintplexlabs/anythingllm:master`
|
||||||
[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)
|
### How to get started (Development environment)
|
||||||
- `yarn setup` from the project root directory.
|
- `yarn setup` from the project root directory.
|
||||||
|
@ -117,7 +117,7 @@
|
|||||||
"AnythingLLMInstanceSecurityGroup": {
|
"AnythingLLMInstanceSecurityGroup": {
|
||||||
"Type": "AWS::EC2::SecurityGroup",
|
"Type": "AWS::EC2::SecurityGroup",
|
||||||
"Properties": {
|
"Properties": {
|
||||||
"GroupDescription": "AnythingLLm Instance Security Group",
|
"GroupDescription": "AnythingLLM Instance Security Group",
|
||||||
"SecurityGroupIngress": [
|
"SecurityGroupIngress": [
|
||||||
{
|
{
|
||||||
"IpProtocol": "tcp",
|
"IpProtocol": "tcp",
|
||||||
|
@ -5,11 +5,26 @@ Use the Dockerized version of AnythingLLM for a much faster and complete startup
|
|||||||
## Requirements
|
## Requirements
|
||||||
- Install [Docker](https://www.docker.com/) on your computer or machine.
|
- Install [Docker](https://www.docker.com/) on your computer or machine.
|
||||||
|
|
||||||
## Pull from Docker
|
## Recommend way to run dockerized AnythingLLM!
|
||||||
`docker pull mintplexlabs/anythingllm:master`
|
> [!TIP]
|
||||||
`docker run -d -p 3001:3001 mintplexlabs/anythingllm:master`
|
> 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!
|
||||||
|
|
||||||
Go to `http://localhost:3001` and you are now using AnythingLLm!
|
`docker pull mintplexlabs/anythingllm:master`
|
||||||
|
|
||||||
|
```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
|
## Build locally from source
|
||||||
- `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.
|
||||||
|
Loading…
Reference in New Issue
Block a user