Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2025-12-22 19:30:15 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Docs: updates & enhancements for MKDocs (#555)

Browse source 
* Update documents for mkdocs compatibility

* documents update

* documents update

* Update README.md

* Update README.md

add link to "https://docs.librechat.ai" on the logo

* document updates

* docs - badge updates

* docs - badge updates

* docs - badge updates

* Update docker_install.md

* Update .env.example

update default MONGO_URI to port 27018 so local install can communicate with the docker db

* Update windows_install.md

fix typo
This commit is contained in:
Fuegovic 2023-07-01 20:11:37 -04:00 • committed by GitHub
parent d7270a1676
commit df2a68e1e7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
75 changed files with 1129 additions and 209 deletions
Download patch file Download diff file Expand all files Collapse all files

15
docs/deployment/cloudflare.md
View file

@ -1,9 +1,10 @@
[<img src="../assets/Cloudflare-logo.jpg" width="350">](https://www.cloudflare.com/)
[<img src="../assets/docs/deployment/cloudflare-logo.jpg" width="350">](https://www.cloudflare.com/)
#Cloudflare
## if you are new to Domain, here's a quick guide to use setup a domain with Cloudflare:
**Google Domains and Cloudflare**
## Google Domains and Cloudflare
- buy a domain at https://domains.google.com/
- register a Cloudflare account at https://dash.cloudflare.com/sign-up
@ -16,7 +17,7 @@
- return to the cloudflare tab and tap on `Done, check nameservers`, then `finish later` and `Check nameservers` (this process can take about 5 minutes)
- in the `DNS` tab select `Records` and `Add Record`
![248543319-77618430-d346-49a9-a5d3-17eac0270ccf](../assets/1-cloudflare.png)
![248543319-77618430-d346-49a9-a5d3-17eac0270ccf](../assets/docs/deployment/cloudflare-1.png)
(in the Name section, if you use @ it will use you main domain, but if you want to use a subdomain write it in the Name section)
- For example: if you want to acces with chat.yourdomain.com just set in the Name section `chat`
@ -27,7 +28,7 @@
If you want to use LibreChat exclusively for yourself or your family and set up an additional layer of protection, you can utilize Cloudflare Zero Trust. Here's how:
**Install Cloudflare Tunnel:**
### Install Cloudflare Tunnel:
- Go to `https://dash.cloudflare.com/`.
- On the left side, click on **Zero Trust**.
@ -39,7 +40,7 @@ If you want to use LibreChat exclusively for yourself or your family and set up
- If you choose Docker: Simply copy the displayed command and paste it into the terminal. Before running it, add `-d` after `docker run`, like this: `docker run -d cloudflare/cloudflared:latest...` (this will run the Docker process in the background).
- In the **Public Hostname** tab, select **Add a public hostname**.
![image](../assets/2-cloudflare.png)
![image](../assets/docs/deployment/cloudflare-2.png)
@ -72,3 +73,7 @@ After adding at least one login method, return to the **Applications** section,
- Turn off "Accept all available identity providers".
- Select your social login method and deselect "One-time PIN".
- Click on **Save application**.
---
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.

2
docs/deployment/heroku.md
View file

@ -190,5 +190,5 @@ heroku config:set KEY_NAME=KEY_VALUE --app your-app-name
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/new?category=troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.

2
docs/deployment/hetzner_ubuntu.md
View file

@ -137,4 +137,4 @@ ALLOW_REGISTRATION:False
---
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/new?category=troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.

37
docs/deployment/linode.md
View file

@ -1,9 +1,11 @@
[<img src="../assets/linode-logo.jpg" width="250">](https://www.linode.com/)
[<img src="../assets/docs/deployment/linode-logo.jpg" width="250">](https://www.linode.com/)
# Linode (⚠️Payment required)
# Linode
**Create a Linode Account and a Linode Server**
⚠️**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.
- 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.
@ -12,7 +14,7 @@
- Configure the server settings such as the server's label, root password, and SSH key. If you don't know which image to use, select 🐧💻 Ubuntu 22.04 LTS
- Click on the 'Create' button to provision the Linode server (wait about 5 minutes after the server is on, because the server is not actually powered on yet)
**Install Docker:**
## Install Docker:
- Connect to your Linode server via SSH using a terminal or SSH client.
- Run the following commands to install Docker and Docker-compose:
@ -52,24 +54,31 @@ if you want, you can use NGINX, Apache, or any other proxy manager.
- ./letsencrypt:/etc/letsencrypt
```
- **Run** `docker-compose up -d` to start NGINX Proxy Manager
### Start NGINX Proxy Manager
- By executing: `docker-compose up -d`
### Login to NGINX Proxy Manager
- **Important: You need to update the default credentials**
- Login to NGINX Proxy Manager and change the username and password.
- The default login link is at `your_linode_ip:81`.
The default login link is at `your_linode_ip:81`.
Default Admin User:
- Default Admin User:
```
Email: admin@example.com
Password: changeme
```
- Login to NGINX Proxy Manager.
- Click on "Proxy Host" and add a proxy host.
### Login to NGINX Proxy Manager.
- Click on "Proxy Host" and add a proxy host.
![248540414-0dbbfdbb-063e-4fa5-bb1d-811064cc4bad](../assets/1-linode.png)
![248540414-0dbbfdbb-063e-4fa5-bb1d-811064cc4bad](../assets/docs/deployment/linode-1.png)
- If you want, you can add the Let's Encrypt SSL certificate.
- If you want, you can add the `Let's Encrypt SSL` certificate.
![248540572-6d0220e2-2506-4b40-8974-a5014df646d6](../assets/2-linode.png)
![248540572-6d0220e2-2506-4b40-8974-a5014df646d6](../assets/docs/deployment/linode-2.png)
---
### Note: If you're still having trouble, before creating a new issue, please search for similar ones on our [#issues thread on our discord](https://discord.gg/weqZFtD9C4) or our [troubleshooting discussion](https://github.com/danny-avila/LibreChat/discussions/categories/troubleshooting) on our Discussions page. If you don't find a relevant issue, feel free to create a new one and provide as much detail as possible.