From 26ea990045af64e7dc264c43fd254df4ef9f6971 Mon Sep 17 00:00:00 2001 From: Fuegovic <32828263+fuegovic@users.noreply.github.com> Date: Thu, 18 Apr 2024 07:31:44 -0400 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=98=20docs:=20update=20docker=5Fcompos?= =?UTF-8?q?e=5Finstall.md=20(#2447)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update docker_compose_install.md * Update docker_compose_install.md --- .../installation/docker_compose_install.md | 26 +++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/install/installation/docker_compose_install.md b/docs/install/installation/docker_compose_install.md index 9a14b48379..b980e572a8 100644 --- a/docs/install/installation/docker_compose_install.md +++ b/docs/install/installation/docker_compose_install.md @@ -10,6 +10,32 @@ Docker Compose installation is recommended for most use cases. It's the easiest, If you prefer to watch a video, we have video guides for [Windows](./windows_install.md#recommended) and [Ubuntu 22.04 LTS](./linux_install.md#recommended) +## Quick Start - TL;DR +Here's the quick summary to get started with the default configuration: +> Requirement: `Git` and `Docker` + +- Clone the repo +```bash + git clone https://github.com/danny-avila/LibreChat.git +``` +- navigate to the LibreChat folder +```bash + cd LibreChat +``` +- Create a .env from the .env.example + - note: you might need to use `copy` instead of `cp` if you're using Windows 10 +```bash + cp .env.example .env +``` +- Start LibreChat +```sh + docker compose up -d +``` +- Access LibreChat +> visit [http://localhost:3080/](http://localhost:3080/) + +- ⚠️ Refer to the remaining sections of this guide as well as our other guides for more advanced configuration options and updates. + ## Installation and Configuration ### Preparation