mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-02-27 12:54:09 +01:00
🪪mkdocs: social cards (#1428)
* mkdocs plugins: add plugin for social cards and plugin that allow to exclude a folder * docs: fix hyperlinks * mkdocs: social cards (descriptions) for 'contributions' and 'deployment' guides * mkdocs: social cards (descriptions) for all 'index.md' * mkdocs: social cards (descriptions) for 'features' and 'plugins' * mkdocs: social cards (descriptions) for 'general_info' * mkdocs: social cards (descriptions) for 'configuration' * mkdocs: social cards (descriptions) for 'installation' * mkdocs: minor fixes * update librechat.svg * update how_to_contribute.md add reference to the official GitHub documentation
This commit is contained in:
Fuegovic
GitHub
parent
18cd02d44e
commit
bce4f41fae
62 changed files with 393 additions and 329 deletions
|
|
@ -1,9 +1,10 @@
|
|||
---
|
||||
title: 🦦 Container (podman)
|
||||
title: 🦦 Container (Podman)
|
||||
description: Install LibreChat using Podman. If you don't like docker compose, don't want a bare-metal installation, but still want to leverage the benefits from the isolation and modularity of containers...
|
||||
weight: 0
|
||||
---
|
||||
|
||||
# Container Installation Guide (podman)
|
||||
# Container Installation Guide (Podman)
|
||||
|
||||
If you don't like docker compose, don't want a bare-metal installation, but still want to leverage the benefits from the isolation and modularity of containers - this is the guide you should use.
|
||||
|
||||
|
|
@ -181,7 +182,7 @@ podman volume export librechat-meilisearch-data --output "librechat-meilisearch-
|
|||
podman volume export librechat-mongodb-data --output "librechat-mongodb-backup-$(date +"%d-%m-%Y").tar"
|
||||
```
|
||||
|
||||
These will leave archive files that you can do what you wish with, including reverting volumes to a previous state if needed. Refer to [podman documentation](https://docs.podman.io/en/latest/markdown/podman-volume-import.1.html) for how to do this.
|
||||
These will leave archive files that you can do what you wish with, including reverting volumes to a previous state if needed. Refer to the **[official podman documentation](https://docs.podman.io/en/latest/markdown/podman-volume-import.1.html)** for how to do this.
|
||||
|
||||
## Updating LibreChat
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: 🐳 Docker Compose ✨(Recommended)
|
||||
description: "Docker Compose Installation Guide: Docker Compose installation is recommended for most use cases. It's the easiest, simplest, and most reliable method to get started."
|
||||
weight: -10
|
||||
---
|
||||
|
||||
|
|
@ -19,7 +20,7 @@ Start by cloning the repository or downloading it to your desired location:
|
|||
```
|
||||
|
||||
### Docker Installation
|
||||
Install Docker on your system. [Docker Desktop](https://www.docker.com/products/docker-desktop/) is recommended for managing your Docker containers.
|
||||
Install Docker on your system. **[Docker Desktop](https://www.docker.com/products/docker-desktop/)** is recommended for managing your Docker containers.
|
||||
|
||||
### LibreChat Configuration
|
||||
Before running LibreChat with Docker, you need to configure some settings:
|
||||
|
|
@ -27,7 +28,7 @@ Before running LibreChat with Docker, you need to configure some settings:
|
|||
- Edit the credentials you see in `docker-compose.yml` under the API service as needed.
|
||||
- See my notes below for specific instructions on some of the configuration
|
||||
- Provide all necessary credentials in the `.env` file before the next step.
|
||||
- Docker will read this env file. See the `.env.example` file for reference.
|
||||
- Docker will read this env file. See the **[/.env.example](https://github.com/danny-avila/LibreChat/blob/main/.env.example)** file for reference.
|
||||
|
||||
#### [AI Setup](../configuration/ai_setup.md) (Required)
|
||||
At least one AI endpoint should be setup for use.
|
||||
|
|
|
|||
|
|
@ -1,11 +1,12 @@
|
|||
---
|
||||
title: Installation
|
||||
description: 🧑💻 This section contains the installation guides for Docker, Podman, Windows, Mac and Linux.
|
||||
weight: 1
|
||||
---
|
||||
|
||||
# Installation
|
||||
* 🐳 [Docker Compose (✨ Recommended)](docker_compose_install.md)
|
||||
* 🦦 [Container (podman)](container_install.md)
|
||||
* 🦦 [Container (Podman)](container_install.md)
|
||||
* 🐧 [Linux](linux_install.md)
|
||||
* 🍎 [Mac](mac_install.md)
|
||||
* 🪟 [Windows](windows_install.md)
|
||||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: 🐧 Linux
|
||||
description: Linux Installation Guides
|
||||
weight: 0
|
||||
---
|
||||
# Linux Installation Guide
|
||||
|
|
@ -73,17 +74,17 @@ Note: The above command extracts the files to "/usr/local/LibreChat". If you wan
|
|||
|
||||
## Enable the Conversation search feature: (optional)
|
||||
|
||||
- Download MeiliSearch latest release from: https://github.com/meilisearch/meilisearch/releases
|
||||
- Copy it to "/usr/local/LibreChat/"
|
||||
- Rename the file to "meilisearch"
|
||||
- Open a terminal and navigate to "/usr/local/LibreChat/"
|
||||
- Download MeiliSearch latest release from: **[github.com/meilisearch](https://github.com/meilisearch/meilisearch/releases)**
|
||||
- Copy it to `/usr/local/LibreChat/`
|
||||
- Rename the file to `meilisearch`
|
||||
- Open a terminal and navigate to `/usr/local/LibreChat/`
|
||||
- Run the following command:
|
||||
|
||||
```bash
|
||||
./meilisearch --master-key=YOUR_MASTER_KEY
|
||||
```
|
||||
|
||||
Note: Replace "YOUR_MASTER_KEY" with the generated master key, which you saved earlier.
|
||||
Note: Replace `YOUR_MASTER_KEY` with the generated master key, which you saved earlier.
|
||||
|
||||
## Install Node.js:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: 🍎 Mac
|
||||
description: Mac Installation Guides
|
||||
weight: 0
|
||||
---
|
||||
|
||||
|
|
@ -12,7 +13,7 @@ weight: 0
|
|||
## **Manual Installation**
|
||||
|
||||
### Install the prerequisites (Required)
|
||||
- Install Homebrew (if not already installed) by following the instructions on https://brew.sh/
|
||||
- Install Homebrew (if not already installed) by following the instructions on **[brew.sh](https://brew.sh/)**
|
||||
- Install Node.js and npm by running `brew install node`
|
||||
|
||||
### Download LibreChat (Required)
|
||||
|
|
@ -38,7 +39,7 @@ weight: 0
|
|||
|
||||
### **Download MeiliSearch for macOS (Optional):**
|
||||
- This enables the conversation search feature
|
||||
- You can download the latest MeiliSearch binary for macOS from their GitHub releases page: https://github.com/meilisearch/MeiliSearch/releases
|
||||
- You can download the latest MeiliSearch binary for macOS from their GitHub releases page: **[github.com/meilisearch](https://github.com/meilisearch/meilisearch/releases)**
|
||||
- Look for the file named `meilisearch-macos-amd64` (or the equivalent for your system architecture) and download it.
|
||||
|
||||
- **Make the binary executable:**
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
title: 🪟 Windows
|
||||
description: Windows Installation Guides
|
||||
weight: 0
|
||||
---
|
||||
|
||||
|
|
@ -26,8 +27,8 @@ In this video we're going to install LibreChat on Windows 11 using Docker and Gi
|
|||
|
||||
#### Instructions
|
||||
- To install LibreChat, you need Docker desktop and Git. Download them from these links:
|
||||
- Docker desktop: https://www.docker.com/products/docke...
|
||||
- Git: https://git-scm.com/download/win
|
||||
- Docker desktop: **[https://docs.docker.com/desktop/install/windows-install/](https://docs.docker.com/desktop/install/windows-install/)**
|
||||
- Git: **[https://git-scm.com/download/win](https://git-scm.com/download/win)**
|
||||
- Follow the steps in the video to install and run Docker desktop and Git.
|
||||
- Open a terminal in the root of the C drive and enter these commands:
|
||||
- `git clone https://github.com/danny-avila/LibreChat`
|
||||
|
|
@ -52,7 +53,7 @@ Have fun!
|
|||
|
||||
### Download and Install Node.js (Required)
|
||||
|
||||
- Navigate to https://nodejs.org/en/download and to download the latest Node.js version for your OS (The Node.js installer includes the NPM package manager.)
|
||||
- Navigate to **[https://nodejs.org/en/download](https://nodejs.org/en/download)** and to download the latest Node.js version for your OS (The Node.js installer includes the NPM package manager.)
|
||||
|
||||
### Download and Install Git (Recommended)
|
||||
- Git: https://git-scm.com/download/win
|
||||
|
|
@ -63,15 +64,12 @@ Have fun!
|
|||
- At least one AI endpoint should be setup for use.
|
||||
|
||||
### Download LibreChat (Required)
|
||||
- (With Git) Open Terminal (command prompt) and clone the repository by running `git clone https://github.com/danny-avila/LibreChat.git`
|
||||
- Or download the latest release here: https://github.com/danny-avila/LibreChat/releases/
|
||||
- Or by clicking on the green code button in the top of the page and selecting "Download ZIP"
|
||||
- If you downloaded a zip file, extract the content in "C:/LibreChat/"
|
||||
- Open Terminal (command prompt) and clone the repository by running `git clone https://github.com/danny-avila/LibreChat.git`
|
||||
- **IMPORTANT : If you install the files somewhere else modify the instructions accordingly**
|
||||
|
||||
### Enable the Conversation search feature: (optional)
|
||||
|
||||
- Download MeiliSearch latest release from : https://github.com/meilisearch/meilisearch/releases
|
||||
- Download MeiliSearch latest release from : **[github.com/meilisearch](https://github.com/meilisearch/meilisearch/releases)**
|
||||
- Copy it to "C:/LibreChat/"
|
||||
- Rename the file to "meilisearch.exe"
|
||||
- Open it by double clicking on it
|
||||
|
|
@ -89,7 +87,7 @@ Using the command line (in the root directory)
|
|||
### To use the app:
|
||||
1. Run `npm run backend`
|
||||
2. Run `meilisearch --master-key <meilisearch_Master_Key>` (Only if SEARCH=TRUE)
|
||||
3. Visit http://localhost:3080 (default port) & enjoy
|
||||
3. Visit `http://localhost:3080` (default port) & enjoy
|
||||
|
||||
### Using a batch file
|
||||
|
||||
|
|
@ -98,7 +96,7 @@ Using the command line (in the root directory)
|
|||
- Paste the following code in a new document
|
||||
- The meilisearch executable needs to be at the root of the LibreChat directory
|
||||
- Put your MeiliSearch master key instead of "`<meilisearch_Master_Key>`"
|
||||
- Save the file as "C:/LibreChat/LibreChat.bat"
|
||||
- Save the file as `C:/LibreChat/LibreChat.bat`
|
||||
- you can make a shortcut of this batch file and put it anywhere
|
||||
|
||||
```bat title="LibreChat.bat"
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue