📝 docs: add env changes to breaking_changes.md and minor fixes (#1812)

* 📝 docs: add env changes to breacking_changes.md

* 📝 docs: replace example in docker_override.md

* 📝 docs: fix images in zeabur.md
This commit is contained in:
Fuegovic 2024-02-19 09:41:07 -05:00 committed by GitHub
parent 5291d18f38
commit 7442955a1d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 85 additions and 15 deletions

View file

@ -36,7 +36,9 @@ Make your desired changes by uncommenting the relevant sections and customizing
> Warning: You can only specify every service name once (api, mongodb, meilisearch, ...) If you want to override multiple settings in one service you will have to edit accordingly.
For example, if you want to make sure Docker can use your `librechat.yaml` file for [custom configuration](./custom_config.md), it would look like this:
### Examples
If you want to make sure Docker can use your `librechat.yaml` file for [custom configuration](./custom_config.md), it would look like this:
```yaml
version: '3.4'
@ -47,7 +49,7 @@ services:
- ./librechat.yaml:/app/librechat.yaml
```
Or, if you want to use a prebuilt image for the `api` service, use the LibreChat config file, and expose MongoDB's port, your `docker-compose.override.yml` might look like this:
Or, if you want to use a prebuilt image for the `api` service, use the LibreChat config file, and use the older Mongo that doesn't requires AVX support, your `docker-compose.override.yml` might look like this:
```yaml
version: '3.4'
@ -59,11 +61,10 @@ services:
image: ghcr.io/danny-avila/librechat-dev:latest
mongodb:
ports:
- 27018:27017
image: mongo:4.4.18
```
> Note: Be cautious with exposing ports like MongoDB to the public, as it can make your database vulnerable to attacks.
> Note: Be cautious if you expose ports for MongoDB or Meilisearch to the public, as it can make your data vulnerable.
## Step 3: Apply the changes

View file

@ -841,3 +841,26 @@ Mail address for from field. It is **REQUIRED** to set a value here (even if it'
```bash
EMAIL_FROM=noreply@librechat.ai
```
### Other
- **Redis:** Redis support is experimental, you may encounter some problems when using it.
> If using Redis, you should flush the cache after changing any LibreChat settings
```bash
REDIS_URI=
USE_REDIS=
```
- **Birthday Hat:** Give the AI Icon a Birthday Hat 🥳
> Will show automatically on February 11th (LibreChat's birthday)
> Set this to `false` to disable the birthday hat
> Set to `true` to enable all the time.
```bash
SHOW_BIRTHDAY_ICON=true
```