From 315faf707e831c23e255504d0d3c2957d4cdc1c3 Mon Sep 17 00:00:00 2001 From: Danny Avila <110412045+danny-avila@users.noreply.github.com> Date: Fri, 4 Aug 2023 14:40:56 -0400 Subject: [PATCH] Update and rename azure.md to azure-terraform.md with repo instructions --- docs/deployment/azure-terraform.md | 30 ++++++++++++++++++++++++++++++ docs/deployment/azure.md | 5 ----- 2 files changed, 30 insertions(+), 5 deletions(-) create mode 100644 docs/deployment/azure-terraform.md delete mode 100644 docs/deployment/azure.md diff --git a/docs/deployment/azure-terraform.md b/docs/deployment/azure-terraform.md new file mode 100644 index 0000000000..fca5473dc5 --- /dev/null +++ b/docs/deployment/azure-terraform.md @@ -0,0 +1,30 @@ +# Azure deployment + +There are different ways of how a deployment can be done in Azure. +One way is to use Terraform to setup all the necessary ressources automatically, here is an [example setup](https://github.com/thunderbug1/LibreChatAzureDeployment) with the setup instructions, which sets up all the necessary services. + +## Prerequisites + +You must have an existing Azure subscription for this to work. + +## Steps + +1. **Clone the [LibreChatAzureDeployment repository](https://github.com/thunderbug1/LibreChatAzureDeployment).** + +2. **Open in VS-Code Devcontainer.** + +3. **[Optional] Configure Deployment:** + * Edit `terraform.tfvars` to customize your deployment. + * You can for example set the `MONGO_URI` which is the connection string to your MongoDB. A fast and simple solution for that is a free cloud instance, like setting up an [Atlas Instance](https://github.com/danny-avila/LibreChat/blob/main/docs/install/mongodb.md). By default a CosmosDB instance is set up automatically. + +4. **Azure Login:** Open the Terminal inside of VS-Code, and run the command `az login`. + +5. **Terraform Initialization:** In the Terminal inside of VS-Code, run the command `terraform init`. + +6. **Apply Terraform Configuration:** In the Terminal inside of VS-Code, run the command `terraform apply`. + +7. **Open LibreChat:** After finishing, terraform shows the outputs in the terminal. Open the Url of "libre_chat_url" (it might take some minutes until everything has booted) +## Teardown + +To tear down your Azure resources, run the command `terraform destroy` in the Terminal inside of VS-Code. + diff --git a/docs/deployment/azure.md b/docs/deployment/azure.md deleted file mode 100644 index a3fcb3e887..0000000000 --- a/docs/deployment/azure.md +++ /dev/null @@ -1,5 +0,0 @@ -# Azure deployment - -There are different ways of how a deployment can be done in Azure. -One way is to use Terraform to setup all the necessary ressources automatically, here is an [example setup](https://github.com/thunderbug1/LibreChatAzureDeployment) with the setup instructions. -After following the setup instructions, you will be able to reach your instance with the url that is shown after the "terraform apply" command. \ No newline at end of file