Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2026-01-07 19:18:52 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

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

12
docs/install/docker_install.md
View file

@ -7,16 +7,14 @@ Docker installation is recommended for most use cases. It's the easiest, simples
git clone https://github.com/danny-avila/LibreChat.git
```
- Install **Docker:** [Docker Desktop](https://www.docker.com/products/docker-desktop/) is recommended for managing your docker container
- **Edit** the credentials you see in [docker-compose.yml](https://stackedit.io/docker-compose.yml) under api service as needed
- **Edit** the credentials you see in `docker-compose.yml` under api service as needed
- **Provide** all necessary credentials in the /.env file before the next step
- See my notes below for specific instructions on some of the configuration
- Docker will read those env files. See their respective `.env.example` files for reference
- Docker will read this env file. See the `.env.example` file for reference
- **Run** `docker-compose up` to start the app
- Note: MongoDB does not support older ARM CPUs like those found in Raspberry Pis. However, you can make it work by setting MongoDB’s version to mongo:4.4.18 in docker-compose.yml, the most recent version compatible with
- **That's it!** If you need more detailed information on configuring your compose file, see my notes below.
- **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.**
## [Get Your API keys and Tokens](apis_and_tokens.md) (Required)
- You must set up at least one of these tokens or APIs to run the app.
@ -29,8 +27,6 @@ To update LibreChat. enter these commands one after the other from the root dir:
- docker-compose build
- docker-compose up
##
## Config notes for docker-compose.yml file
- Any environment variables set in your compose file will override variables with the same name in your .env file. Note that the following variables are necessary to include in the compose file so they work in the docker environment, so they are included for you.
@ -109,3 +105,7 @@ Navigate to https://www.mongodb.com/ and Sign In or Create an account
- "Choose a connection method" select "Connect your application"
- Driver = Node.js / Version = 4.1 or later
- Copy the connection string, fill in your password and remove `&w=majority` from default connection string.
---
### 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.