kamp/anything-llm
1
0
Fork 0
mirror of https://github.com/Mintplex-Labs/anything-llm.git synced 2024-11-14 02:20:12 +01:00
Code Issues Packages Projects Releases Wiki Activity
668a49c826
anything-llm/aws/cloudformation/DEPLOY.md
Timothy Carambat 4dd1887bd1
Easy AWS cloud deployment for private instances via CloudFormation template (#52) 
* wip

* fix file ref

* update dockerfile

* mute chown

* add build script for AWS CF template construction
add comment about script and AWS deployment

* move aws stuff into its own folder

* edit readme
2023-06-14 10:34:22 -07:00

2.6 KiB
Raw Blame History

How to deploy a private AnythingLLM instance on AWS

With an AWS account you can easily deploy a private AnythingLLM instance on AWS. This will create a url that you can access from any browser over HTTP (HTTPS not supported). This single instance will run on your own keys and they will not be exposed - however if you want your instance to be protected it is highly recommend that you set the AUTH_TOKEN and JWT_SECRET variables in the docker/ ENV.

Refer to .env.example for data format.

The output of this cloudformation stack will be:

  • 1 EC2 Instance
  • 1 Security Group with 0.0.0.0/0 access on Ports 22 & 3001
  • 1 EC2 Instance Volume gb2 of 10Gib minimum

Requirements

  • An AWS account with billing information.
    • AnythingLLM can run within the free tier using a t2.micro and 10Gib SSD hard disk volume
  • .env file that is filled out with your settings and set up in the docker/ folder

How to deploy on AWS

  1. Generate your specific cloudformation document by running yarn generate:cloudformation from the project root directory.
  2. Log in to your AWS account
  3. Open CloudFormation
  4. Ensure you are deploying in a geographic zone that is nearest to your physical location to reduce latency.
  5. Click Create Stack

Create Stack

  1. Upload your aws_cf_deploy_anything_llm.json to the stack

Upload Stack

  1. Click Next and give your stack a name. This is superficial.
  2. No other changes are needed, just proceed though each step
  3. Click Submit
  4. Wait for stack events to finish and be marked as Completed
  5. View Outputs tab.

Stack Output

Please read this notice before submitting issues about your deployment

Note: Your instance will not be available instantly. Depending on the instance size you launched with it can take anywhere from 10-20 minutes to fully boot up.

If you want to check the instances progress, navigate to your deployed EC2 instances and connect to your instance via SSH in browser.

Once connected run sudo tail -f /var/log/cloud-init-output.log and wait for the file to conclude deployment of the docker image. You should see an output like this

[+] Running 2/2
 ⠿ Network docker_anything-llm  Created 
 ⠿ Container anything-llm       Started

Additionally, your use of this deployment process means you are responsible for any costs of these AWS resources fully.