Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2026-02-04 00:31:50 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

🐳 : Further Docker build Cleanup & Docs Update (#1502)

Browse source 
* refactor: post-cleanup changes:
- add more unnecessary paths to .dockerignore
- remove librechat.yaml from main compose file (prevents from being required)
- do not create librechat.yaml during build (does nothing)

* docs: make config file instructions easier to read, more info throughout other docs

* docs: add custom config to menu

* Update custom_config.md

* Update docker_compose_install.md
This commit is contained in:
Danny Avila 2024-01-06 11:59:08 -05:00 • committed by GitHub
parent 5d7869d3d5
commit 3183d6b678
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
12 changed files with 181 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/install/installation/container_install.md
View file

@ -222,4 +222,40 @@ podman stop librechat && systemctl --user start container-librechat
---
## Integrating the Configuration File in Podman Setup
When using Podman for setting up LibreChat, you can also integrate the [`librechat.yaml` configuration file](../configuration/custom_config.md).
This file allows you to define specific settings and AI endpoints, such as Mistral AI, tailoring the application to your needs.
After creating your `.env` file as detailed in the previous steps, follow these instructions to integrate the `librechat.yaml` configuration:
1. Place your `librechat.yaml` file in your project's root directory.
2. Modify the Podman run command for the LibreChat container to include a volume argument that maps the `librechat.yaml` file inside the container. This can be done by adding the following line to your Podman run command:
```bash
-v "./librechat.yaml:/app/librechat.yaml"
```
For example, the modified Podman run command for starting LibreChat will look like this:
```bash
podman run \
--name="librechat" \
--network=librechat \
--env-file="./.env" \
-v "./librechat.yaml:/app/librechat.yaml" \
-p 3080:3080 \
--detach \
librechat:local;
```
By mapping the `librechat.yaml` file into the container, Podman ensures that your custom configurations are applied to LibreChat, enabling a tailored AI experience.
Ensure that the `librechat.yaml` file is correctly formatted and contains valid settings.
Any errors in this file might affect the functionality of LibreChat. For more information on configuring `librechat.yaml`, refer to the [configuration guide](../configuration/custom_config.md).
---
>⚠️ Note: If you're 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.

3
docs/install/installation/docker_compose_install.md
View file

@ -34,6 +34,9 @@ Before running LibreChat with Docker, you need to configure some settings:
#### [AI Setup](../configuration/ai_setup.md) (Required)
At least one AI endpoint should be setup for use.
#### [Custom Endpoints & Configuration](../configuration/custom_config.md#docker-setup) (Optional)
Allows you to customize AI endpoints, such as Mistral AI, and other settings to suit your specific needs.
#### [Manage Your MongoDB Database](../../features/manage_your_database.md) (Optional)
Safely access and manage your MongoDB database using Mongo Express