mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-24 04:10:15 +01:00
🧹📚 docs: refactor and clean up (#1392)
* 📑 update mkdocs * rename docker override file and add to gitignore * update .env.example - GOOGLE_MODELS * update index.md * doc refactor: split installation and configuration in two sub-folders * doc update: installation guides * doc update: configuration guides * doc: new docker override guide * doc: new beginner's guide for contributions - Thanks @Berry-13 * doc: update documentation_guidelines.md * doc: update testing.md * doc: update deployment guides * doc: update /dev readme * doc: update general_info * doc: add 0 value to doc weight * doc: add index.md to every doc folders * doc: add weight to index.md and move openrouter from free_ai_apis.md to ai_setup.md * doc: update toc so they display properly on the right had side in mkdocs * doc: update pandoranext.md * doc: index logging_system.md * doc: update readme.md * doc: update litellm.md * doc: update ./dev/readme.md * doc:🔖 new presets.md * doc: minor corrections * doc update: user_auth_system.md and presets.md, doc feat: add mermaid support to mkdocs * doc update: add screenshots to presets.md * doc update: add screenshots to - OpenID with AWS Cognito * doc update: BingAI cookie instruction * doc update: discord auth * doc update: facebook auth * doc: corrections to user_auth_system.md * doc update: github auth * doc update: google auth * doc update: auth clean up * doc organization: installation * doc organization: configuration * doc organization: features+plugins & update:plugins screenshots * doc organization: deploymend + general_info & update: tech_stack.md * doc organization: contributions * doc: minor fixes * doc: minor fixes
This commit is contained in:
Fuegovic
GitHub
parent
5c27fa304a
commit
51050cc4d3
66 changed files with 1617 additions and 869 deletions
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: ⚡ Azure
|
||||
weight: -6
|
||||
---
|
||||
# Azure deployment
|
||||
|
||||
There are different ways of how a deployment can be done in Azure.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: ☁️ Cloudflare
|
||||
weight: -7
|
||||
---
|
||||
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/cfbc7ca5-b51e-4f1d-aa89-b9b4cb13eead" width="350">
|
||||
|
||||
# Cloudflare
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🌊 DigitalOcean ✨(Recommended)
|
||||
weight: -10
|
||||
---
|
||||
# Digital Ocean (Ubuntu/Docker) Setup
|
||||
|
||||
>These instructions are designed for someone starting from scratch for a Docker Installation on a remote Ubuntu server. You can skip to any point that is useful for you. There are probably more efficient/scalable ways, but this guide works really great for my personal use case.
|
||||
|
|
@ -334,8 +338,8 @@ ALLOW_REGISTRATION=false
|
|||
```
|
||||
|
||||
**Resources:**
|
||||
- [Tokens/Apis/etc](../install/ai_setup.md)
|
||||
- [User/Auth System](../install/user_auth_system.md)
|
||||
- [Tokens/Apis/etc](../install/configuration/ai_setup.md)
|
||||
- [User/Auth System](../install/configuration/user_auth_system.md)
|
||||
|
||||
### **3. Start docker, and then run the installation/update script**
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🌈 Heroku
|
||||
weight: -1
|
||||
---
|
||||
# Heroku Deployment
|
||||
|
||||
*To run LibreChat on a server, you can use cloud hosting platforms like Heroku, DigitalOcean, or AWS. In this response, I'll provide instructions for deploying the project on Heroku. Other platforms will have slightly different deployment processes.*
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🏗️ Hetzner
|
||||
weight: -2
|
||||
---
|
||||
# Hetzner Ubuntu Setup
|
||||
|
||||
*These instructions are designed for someone starting from scratch for a Ubuntu Installation. You can skip to any point that is useful for you.*
|
||||
|
|
@ -68,9 +72,11 @@ sudo reboot
|
|||
|
||||
## Tokens/Apis/etc:
|
||||
- Make sure you have all the needed variables for the following before moving forward
|
||||
### [Setup your AI Endpoints](../install/ai_setup.md) (Required)
|
||||
|
||||
### [Setup your AI Endpoints](../install/configuration/ai_setup.md) (Required)
|
||||
- At least one AI endpoint should be setup for use.
|
||||
### [User/Auth System](../install/user_auth_system.md) (Optional)
|
||||
### [User/Auth System](../install/configuration/user_auth_system.md) (Optional)
|
||||
|
||||
- How to set up the user/auth system and Google login.
|
||||
### [Plugins](../features/plugins/introduction.md)
|
||||
- Optional plugins available to enhance the application.
|
||||
|
|
@ -79,7 +85,7 @@ sudo reboot
|
|||
|
||||
## Using Docker to Install the Service
|
||||
|
||||
### 1. **Recommended: [Docker Install](../install/docker_compose_install.md)**
|
||||
### 1. **Recommended: [Docker Install](../install/installation/docker_compose_install.md)**
|
||||
From the *server* commandline (as your user, not root):
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🤗 HuggingFace
|
||||
weight: -9
|
||||
---
|
||||
# Hugging Face Deployment 🤗
|
||||
|
||||
>#### ⚠️ Note - Some features are not supported by HuggingFace:
|
||||
|
|
@ -11,7 +15,7 @@
|
|||
|
||||
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/mongodb.md)
|
||||
Follow the instructions in this document: [Online MongoDB Database](../install/configuration/mongodb.md)
|
||||
|
||||
## Getting Started
|
||||
|
||||
|
|
|
|||
17
docs/deployment/index.md
Normal file
17
docs/deployment/index.md
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
---
|
||||
title: Deployment
|
||||
weight: 3
|
||||
---
|
||||
|
||||
# Deployment
|
||||
|
||||
* 🌊 [DigitalOcean (✨Recommended)](digitalocean.md)
|
||||
* 🤗 [HuggingFace](huggingface.md)
|
||||
* 🐧 [Linode](linode.md)
|
||||
* ☁️ [Cloudflare](cloudflare.md)
|
||||
* ⚡ [Azure](azure-terraform.md)
|
||||
* 🪨 [Ngrok](ngrok.md)
|
||||
* ⏹️ [Render](render.md)
|
||||
* 🔎 [Meilisearch in Render](meilisearch_in_render.md)
|
||||
* 🏗️ [Hetzner](hetzner_ubuntu.md)
|
||||
* 🌈 [Heroku](heroku.md)
|
||||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🐧 Linode
|
||||
weight: -8
|
||||
---
|
||||
<img src="https://github.com/danny-avila/LibreChat/assets/32828263/d6e430db-518a-4779-83d3-a2d177907df1" width="250">
|
||||
|
||||
# Linode
|
||||
|
|
@ -21,7 +25,7 @@
|
|||
sudo apt update
|
||||
sudo apt install docker.io && apt install docker-compose
|
||||
```
|
||||
## [Install LibreChat](../install/docker_compose_install.md)
|
||||
## [Install LibreChat](../install/installation/docker_compose_install.md)
|
||||
|
||||
## Install and Setup NGINX Proxy Manager:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🔎 Meilisearch in Render
|
||||
weight: -3
|
||||
---
|
||||
# Utilize Meilisearch by running LibreChat on Render
|
||||
|
||||
## Create a new account or a new project on Render
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: 🪨 Ngrok
|
||||
weight: -5
|
||||
---
|
||||
# Ngrok Installation
|
||||
|
||||
To use Ngrok for tunneling your local server to the internet, follow these steps:
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
title: ⏹️ Render
|
||||
weight: -4
|
||||
---
|
||||
# Render Deployment
|
||||
|
||||
## Note:
|
||||
|
|
@ -78,7 +82,7 @@ Also:
|
|||
|
||||
The last 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/mongodb.md)
|
||||
Follow the instructions in this document: [Online MongoDB Database](../install/configuration/mongodb.md)
|
||||
|
||||
## Complete the Environment Variables configuration
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue