Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-17 00:40:14 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 6

🪪mkdocs: social cards (#1428)

Browse source 
* 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 2023-12-28 17:10:06 -05:00 • committed by GitHub
parent 18cd02d44e
commit bce4f41fae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
62 changed files with 393 additions and 329 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/deployment/azure-terraform.md
View file

@ -1,5 +1,6 @@
---
title: ⚡ Azure
description: How to deploy LibreChat in Azure using Terraform.
weight: -6
---
# Azure deployment

9
docs/deployment/cloudflare.md
View file

@ -1,5 +1,6 @@
---
title: ☁️ Cloudflare
description: How to setup a domain with Cloudflare and use Cloudflare Tunnels to securely expose your local web servers or services to the internet.
weight: -7
---
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/cfbc7ca5-b51e-4f1d-aa89-b9b4cb13eead" width="350">
@ -9,12 +10,12 @@ weight: -7
## Google Domains and Cloudflare
- buy a domain at https://domains.google.com/
- register a Cloudflare account at https://dash.cloudflare.com/sign-up
- buy a domain at **[https://domains.google.com/](https://domains.google.com)**
- register a Cloudflare account at **[https://dash.cloudflare.com/sign-up](https://dash.cloudflare.com/sign-up)**
- click on `add site` and add your domain
- select `Free` and tap `continue` twice
- copy the 2 Cloudflare's nameservers
- go to https://domains.google.com/registrar/ and select your domain
- go to **[https://domains.google.com/registrar/](https://domains.google.com/registrar)** and select your domain
- in the dns tab select `Custom name servers`
- click on `Switch to these settings` and enter the two Cloudflare nameservers that you copied before, then save
- return to the cloudflare tab and tap on `Done, check nameservers`, then `finish later` and `Check nameservers` (this process can take about 5 minutes)
@ -73,7 +74,7 @@ Here's a straightforward guide on how to install it!
### Installation Steps
1. Go to `https://dash.cloudflare.com/`.
1. Go to **[https://dash.cloudflare.com/](https://dash.cloudflare.com/)**.
2. On the left side, click on **Zero Trust**.
3. Provide a casual name (which you can change later).
4. Select the free plan and proceed to payment (if you choose the free plan, you will not be charged).

3
docs/deployment/digitalocean.md
View file

@ -1,5 +1,6 @@
---
title: 🌊 DigitalOcean ✨(Recommended)
description: These instructions are designed for someone starting from scratch for a Docker Installation on a remote Ubuntu server using one of the cheapest tiers (6 USD/mo)
weight: -10
---
# Digital Ocean (Ubuntu/Docker) Setup
@ -366,7 +367,7 @@ It's safe to close the terminal if you wish -- the docker app will continue to r
>If you are setting up a domain to be used with LibreChat, this compose file is using the nginx file located in client/nginx.conf. Instructions on this below in part V.
### **4. Once the app is running, you can access it at http://yourserverip**
### **4. Once the app is running, you can access it at `http://yourserverip`**
### Go back to the DigitalOcean droplet page to get your server ip, copy it, and paste it into your browser!

11
docs/deployment/heroku.md
View file

@ -1,5 +1,6 @@
---
title: 🌈 Heroku
description: Instructions for deploying LibreChat on Heroku
weight: -1
---
# Heroku Deployment
@ -10,8 +11,8 @@ Heroku only supports running a single process within a Docker container. The Doc
If you want to deploy both these services to Heroku, you will need to create two separate Dockerfiles: one for the API and one for the client. The heroku.yml should be configured separately for each app, and then you need to create and deploy two different Heroku apps.
- Sign up for a Heroku account: If you don't already have a Heroku account, sign up at https://signup.heroku.com/.
- Install the Heroku CLI: Download and install the Heroku CLI from https://devcenter.heroku.com/articles/heroku-cli.
- Sign up for a Heroku account: If you don't already have a Heroku account, sign up at: **[https://signup.heroku.com](https://signup.heroku.com)**
- Install the Heroku CLI: Download and install the Heroku CLI from: **[https://devcenter.heroku.com/articles/heroku-cli](https://devcenter.heroku.com/articles/heroku-cli)**
Here are the steps to deploy on Heroku:
@ -126,7 +127,7 @@ Remember to replace `your-api-app-name` and `your-client-app-name` with the actu
---
⚠️ If you have issues, see this discussion first: https://github.com/danny-avila/LibreChat/discussions/339
⚠️ If you have issues, see this discussion first: **[https://github.com/danny-avila/LibreChat/discussions/339](https://github.com/danny-avila/LibreChat/discussions/339)**
## Using Heroku Dashboard:
@ -136,7 +137,7 @@ Remember to replace `your-api-app-name` and `your-client-app-name` with the actu
## Setting up MongoDB Atlas:
Sign up for a MongoDB Atlas account: If you don't have an account, sign up at https://www.mongodb.com/cloud/atlas/signup.
Sign up for a MongoDB Atlas account: If you don't have an account, sign up at: **[https://www.mongodb.com/cloud/atlas/signup](https://www.mongodb.com/cloud/atlas/signup)**
Create a new cluster: After signing in, create a new cluster by following the on-screen instructions. For a free tier cluster, select the "Shared" option and choose the "M0 Sandbox" tier.
@ -148,7 +149,7 @@ Get the connection string: Once the cluster is created, click the "Connect" butt
## Deploying MeiliSearch on Heroku:
Install the Heroku CLI: If you haven't already, download and install the Heroku CLI from https://devcenter.heroku.com/articles/heroku-cli.
Install the Heroku CLI: If you haven't already, download and install the Heroku CLI from: **[https://devcenter.heroku.com/articles/heroku-cli](https://devcenter.heroku.com/articles/heroku-cli)**
Login to Heroku: Open Terminal and run heroku login. Follow the instructions to log in to your Heroku account.
## Create a new Heroku app for MeiliSearch:

17
docs/deployment/hetzner_ubuntu.md
View file

@ -1,5 +1,6 @@
---
title: 🏗️ Hetzner
description: LibreChat Ubuntu installation from scratch on Hetzner.
weight: -2
---
# Hetzner Ubuntu Setup
@ -8,24 +9,24 @@ weight: -2
## Starting from Zero:
### 1. Login to Hetzner Cloud Console (https://console.hetzner.cloud/projects) and Create a new Ubuntu 20 Project with 4GB Ram. Do not worry about SSH keys *yet*.
1. Login to Hetzner Cloud Console (**[https://console.hetzner.cloud/projects](https://console.hetzner.cloud/projects)**) and Create a new Ubuntu 20 Project with 4GB Ram. Do not worry about SSH keys *yet*.
Hetzner will email you the root password.
### 2. Once you have that, you can login with any SSH terminal with:
2. Once you have that, you can login with any SSH terminal with:
```
ssh root@<yourserverip>
```
### 3. Once you have logged in, immediately create a new, non-root user:
3. Once you have logged in, immediately create a new, non-root user:
```
adduser <yourusername>
usermod -aG sudo <yourusername>
```
### 4. Make sure you have done this correctly by double-checking you have sudo permissions:
4. Make sure you have done this correctly by double-checking you have sudo permissions:
```
getent group sudo | cut -d: -f4
@ -33,7 +34,7 @@ getent group sudo | cut -d: -f4
Now, quit the terminal connection.
### 5. Create a local ssh key:
5. Create a local ssh key:
```
ssh-keygen -t ed25519
@ -51,13 +52,13 @@ ssh <yourusername>@<yourserverip>
When you login, now and going forward, it will ask you for the password for your ssh key now, not your user password. Sudo commands will always want your user password.
### 6. Add SSH to the universal server firewall and activate it.
6. Add SSH to the universal server firewall and activate it.
- Run `sudo ufw allow OpenSSH`
- Run `sudo ufw enable`
### 7. Then, we need to install docker, update the system packages, and reboot the server:
7. Then, we need to install docker, update the system packages, and reboot the server:
```
sudo apt install docker
sudo apt install docker-compose
@ -132,7 +133,7 @@ MEILI_HTTP_ADDR=meilisearch
**NOTE: You may need to run these commands with sudo permissions.**
## Once the app is running, you can access it at http://yourserverip:3080
## Once the app is running, you can access it at `http://yourserverip:3080`
It is safe to close the terminal -- the docker app will continue to run.

24
docs/deployment/huggingface.md
View file

@ -1,27 +1,23 @@
---
title: 🤗 HuggingFace
description: Easily deploy LibreChat on Hugging Face Spaces
weight: -9
---
# Hugging Face Deployment 🤗
>#### ⚠️ Note - Some features are not supported by HuggingFace:
>- Meilisearch
>- Social Logins
> #### ❗Also:
>- You will have to create an online MongoDB Atlas Database to be able to properly deploy
## Create and Configure your Database (Required)
The first thing you need is to create a MongoDB Atlas Database and get your connection string.
Follow the instructions in this document: [Online MongoDB Database](../install/configuration/mongodb.md)
Follow the instructions in this document: **[Online MongoDB Database](../install/configuration/mongodb.md)**
## Getting Started
**1.** Login or Create an account on [Hugging Face](https://huggingface.co/)
**1.** Login or Create an account on **[Hugging Face](https://huggingface.co/)**
**2.** Visit [[https://huggingface.co/spaces/LibreChat/template](https://huggingface.co/spaces/LibreChat/template)]and click on `Duplicate this Space` to copy the LibreChat template into your profile
**2.** Visit **[https://huggingface.co/spaces/LibreChat/template](https://huggingface.co/spaces/LibreChat/template)** and click on `Duplicate this Space` to copy the LibreChat template into your profile.
> Note: It is normal for this template to have a runtime error, you will have to configure it using the following guide to make it functional.
![image](https://github.com/fuegovic/LibreChat/assets/32828263/fd684254-cbe0-4039-ba4a-7c492b16a453)
@ -46,12 +42,12 @@ You will need to fill these values:
| JWT_SECRET | * see bellow |
| JWT_REFRESH_SECRET | * see bellow |
> ⬆️ **Leave the value field blank for any endpoints that you wish to disable.**
> ⬆️ **Leave the value field blank for any endpoints that you wish to disable.**
>⚠️ setting the API keys and token to `user_provided` allows you to provide them safely from the webUI
> ⚠️ setting the API keys and token to `user_provided` allows you to provide them safely from the webUI
>* For `CREDS_KEY`, `CREDS_IV` and `JWT_SECRET` use this tool: [https://replit.com/@daavila/crypto#index.js](https://replit.com/@daavila/crypto#index.js).
>* Run the tool a second time and use the new `JWT_SECRET` value for the `JWT_REFRESH_SECRET`
> * For `CREDS_KEY`, `CREDS_IV` and `JWT_SECRET` use this tool: **[https://replit.com/@daavila/crypto#index.js](https://replit.com/@daavila/crypto#index.js)**
> * Run the tool a second time and use the new `JWT_SECRET` value for the `JWT_REFRESH_SECRET`
| Variables | Values |
| --- | --- |

1
docs/deployment/index.md
View file

@ -1,5 +1,6 @@
---
title: Deployment
description: 🌐 Step-by-step guides on how to deploy LibreChat on various cloud platforms.
weight: 3
---

3
docs/deployment/linode.md
View file

@ -1,5 +1,6 @@
---
title: 🐧 Linode
description: How to deploy LibreChat on Linode.
weight: -8
---
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/d6e430db-518a-4779-83d3-a2d177907df1" width="250">
@ -9,7 +10,7 @@ weight: -8
⚠️**Note: Payment is required**
## Create a Linode Account and a Linode Server
- Go to the Linode website (https://www.linode.com/) and click on the "Sign Up" or "Get Started" button.
- Go to the Linode website (**[https://www.linode.com/](https://www.linode.com/)**) and click on the "Sign Up" or "Get Started" button.
- Follow the instructions to create a new account by providing your personal details and payment information.
- Once your account is created, you will have access to the Linode Cloud Manager.
- Click on the "Create" button to create a new Linode server.

3
docs/deployment/meilisearch_in_render.md
View file

@ -1,12 +1,13 @@
---
title: 🔎 Meilisearch in Render
description: Setup Meilisearch on Render (for use with the Render deployment guide)
weight: -3
---
# Utilize Meilisearch by running LibreChat on Render
## Create a new account or a new project on Render
**1.** Visit [https://render.com/](https://render.com/) and click on `Start Free` to create an account and sign in
**1.** Visit **[https://render.com/](https://render.com/)** and click on `Start Free` to create an account and sign in
**2.** Access your control panel

26
docs/deployment/ngrok.md
View file

@ -1,5 +1,6 @@
---
title: 🪨 Ngrok
description: Use Ngrok to tunnel your local server to the internet.
weight: -5
---
# Ngrok Installation
@ -8,44 +9,43 @@ To use Ngrok for tunneling your local server to the internet, follow these steps
## Sign up
1. Go to https://ngrok.com/ and sign up for an account.
1. Go to **[https://ngrok.com/](https://ngrok.com/)** and sign up for an account.
## Docker Installation 🐳
1. Copy your auth token from https://dashboard.ngrok.com/get-started/your-authtoken.
1. Copy your auth token from: **[https://dashboard.ngrok.com/get-started/your-authtoken](https://dashboard.ngrok.com/get-started/your-authtoken)**
2. Open a terminal and run the following command: `docker run -d -it -e NGROK_AUTHTOKEN=<your token> ngrok/ngrok http 80`
## Windows Installation 💙
1. Download the ZIP file from https://ngrok.com/download.
1. Download the ZIP file from: **[https://ngrok.com/download](https://ngrok.com/download)**
2. Extract the contents of the ZIP file using 7zip or WinRar.
3.
4. Run `ngrok.exe`.
5. Copy your auth token from https://dashboard.ngrok.com/get-started/your-authtoken.
6. In the `ngrok.exe` terminal, run the following command: `ngrok config add-authtoken <your token>`
7. If you haven't done so already, start LibreChat normally.
8. In the `ngrok.exe` terminal, run the following command: `ngrok http 3080`
3. Run `ngrok.exe`.
4. Copy your auth token from: **[https://dashboard.ngrok.com/get-started/your-authtoken](https://dashboard.ngrok.com/get-started/your-authtoken)**
5. In the `ngrok.exe` terminal, run the following command: `ngrok config add-authtoken <your token>`
6. If you haven't done so already, start LibreChat normally.
7. In the `ngrok.exe` terminal, run the following command: `ngrok http 3080`
You will see a link that can be used to access LibreChat.
![ngrok-1](https://github.com/danny-avila/LibreChat/assets/32828263/3cb4b063-541f-4f0a-bea8-a04dd36e6bf4)
## Linux Installation 🐧
1. Copy the command from https://ngrok.com/download choosing the **correct** architecture.
1. Copy the command from: **[https://ngrok.com/download](https://ngrok.com/download)** choosing the **correct** architecture.
2. Run the command in the terminal
3. Copy your auth token from https://dashboard.ngrok.com/get-started/your-authtoken.
3. Copy your auth token from: **[https://dashboard.ngrok.com/get-started/your-authtoken](https://dashboard.ngrok.com/get-started/your-authtoken)**
4. run the following command: `ngrok config add-authtoken <your token>`
5. If you haven't done so already, start LibreChat normally.
6. run the following command: `ngrok http 3080`
## Mac Installation 🍎
1. Download the ZIP file from https://ngrok.com/download.
1. Download the ZIP file from: **[https://ngrok.com/download](https://ngrok.com/download)**
2. Extract the contents of the ZIP file using a suitable Mac application like Unarchiver.
3. Open Terminal.
4. Navigate to the directory where you extracted ngrok using the `cd` command.
5. Run ngrok by typing `./ngrok`.
6. Copy your auth token from https://dashboard.ngrok.com/get-started/your-authtoken.
6. Copy your auth token from: **[https://dashboard.ngrok.com/get-started/your-authtoken](https://dashboard.ngrok.com/get-started/your-authtoken)**
7. In the terminal where you ran ngrok, enter the following command: `ngrok authtoken <your token>`
8. If you haven't done so already, start LibreChat normally.
9. In the terminal where you ran ngrok, enter the following command: `./ngrok http 3080`

1
docs/deployment/render.md
View file

@ -1,5 +1,6 @@
---
title: ⏹️ Render
description: How to deploy LibreChat on Render
weight: -4
---
# Render Deployment