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

Update .env.example

Browse source 
I continued the work on the standardization of the layout. I also eliminated duplicate key=value pairs to simplify the configuration and reduce the likelihood of errors. I also updated some of the commented instructions and notes throughout the file to keep the instructions clear while making it easier to prevent errors when using a script to parse the key=value pairs.
This commit is contained in:
Fuegovic 2023-04-25 04:26:38 -04:00 • committed by GitHub
parent e02e6152ed
commit 3eddc9712f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 75 additions and 82 deletions
Download patch file Download diff file Expand all files Collapse all files

157
api/.env.example
View file

@ -1,112 +1,105 @@
##########################
# Server configuration. # Server configuration.
# The server will listen to localhost:3080 request by default. You can set the target ip as you want. ##########################
# If you want this server can be used outside your local machine, for example to share with other
# machine or expose this from a docker container, set HOST=0.0.0.0 or your external ip interface. # The server will listen to localhost:3080 by default. You can change the target IP as you want.
# # If you want to make this server available externally, for example to share the server with others
# Tips: HOST=0.0.0.0 means listening on all interface. It's not a real ip. Use localhost:port rather # or expose this from a Docker container, set host to 0.0.0.0 or your external IP interface.
# than 0.0.0.0:port to open it. # Tips: Setting host to 0.0.0.0 means listening on all interfaces. It's not a real IP.
HOST=localhost # Use localhost:port rather than 0.0.0.0:port to access the server.
HOST=localhost
PORT=3080 PORT=3080
NODE_ENV=development NODE_ENV=development
# Change this to proxy any API request. It's useful if your machine have difficulty calling the original API server. # Change this to proxy any API request.
# PROXY="http://YOUR_PROXY_SERVER" # It's useful if your machine has difficulty calling the original API server.
# PROXY=
# Change this to your MongoDB URI if different and I recommend appending chatgpt-clone # Change this to your MongoDB URI if different and I recommend appending chatgpt-clone
MONGO_URI="mongodb://127.0.0.1:27017/chatgpt-clone" MONGO_URI=mongodb://127.0.0.1:27017/chatgpt-clone
##########################
# OpenAI Endpoint:
##########################
############################# # Access key from OpenAI platform.
# Endpoint OpenAI: # Leave it blank to disable this feature.
#############################
# Access key from OpenAI platform
# Leave it blank to disable this endpoint
OPENAI_KEY= OPENAI_KEY=
# Identify the available models, sperate by comma, and not space in it # Identify the available models, separated by commas *without spaces*.
# The first will be default # The first will be default.
# Leave it blank to use internal settings. # Leave it blank to use internal settings.
OPENAI_MODELS=gpt-3.5-turbo,gpt-3.5-turbo-0301,text-davinci-003,gpt-4 OPENAI_MODELS=gpt-3.5-turbo,gpt-3.5-turbo-0301,text-davinci-003,gpt-4
# Reverse proxy setting for OpenAI # Reverse proxy settings for OpenAI:
# https://github.com/waylaidwanderer/node-chatgpt-api#using-a-reverse-proxy # https://github.com/waylaidwanderer/node-chatgpt-api#using-a-reverse-proxy
# OPENAI_REVERSE_PROXY=<YOUR REVERSE PROXY> # OPENAI_REVERSE_PROXY=
##########################
# BingAI Endpoint:
##########################
############################# # Also used for Sydney and jailbreak
# Endpoint BingAI (Also jailbreak Sydney):
#############################
# BingAI Tokens: the "_U" cookies value from bing.com # BingAI Tokens: the "_U" cookies value from bing.com
# Leave it and BINGAI_USER_TOKEN blank to disable this endpoint. # Leave it blank to disable this endpoint.
# Set to "user_provided" to allow user provided token. BINGAI_TOKEN=
# BINGAI_TOKEN="user_provided"
BINGAI_TOKEN=user_provided
# BingAI Host: # BingAI Host:
# Necessary for some people in different countries, e.g. China (https://cn.bing.com) # Necessary for some people in different countries, e.g. China (https://cn.bing.com)
# Leave it blank to use default server. # Leave it blank to use default server.
# BINGAI_HOST="https://cn.bing.com" # BINGAI_HOST=https://cn.bing.com
##########################
# ChatGPT Endpoint:
##########################
############################# # ChatGPT Browser Client (free but use at your own risk)
# Endpoint chatGPT: # Access token from https://chat.openai.com/api/auth/session
############################# # Exposes your access token to `CHATGPT_REVERSE_PROXY`
# Leave it blank to disable this endpoint
# ChatGPT Browser Client (free but use at your own risk)
# Access token from https://chat.openai.com/api/auth/session
# Exposes your access token to CHATGPT_REVERSE_PROXY
# Leave it blank to disable this endpoint
# Set to "user_provide" to allow user provided token.
# CHATGPT_TOKEN="user_provide"
CHATGPT_TOKEN= CHATGPT_TOKEN=
# Identify the available models, sperate by comma, and not space in it # Identify the available models, separated by commas. The first will be default.
# The first will be default # Leave it blank to use internal settings.
# Leave it blank to use internal settings.
CHATGPT_MODELS=text-davinci-002-render-sha,text-davinci-002-render-paid,gpt-4 CHATGPT_MODELS=text-davinci-002-render-sha,text-davinci-002-render-paid,gpt-4
# Reverse proxy setting for OpenAI # Reverse proxy settings for ChatGPT
# https://github.com/waylaidwanderer/node-chatgpt-api#using-a-reverse-proxy # https://github.com/waylaidwanderer/node-chatgpt-api#using-a-reverse-proxy
# By default it will use the node-chatgpt-api recommended proxy, (it's a third party server) # By default, the server will use the node-chatgpt-api recommended proxy (a third party server).
# CHATGPT_REVERSE_PROXY=<YOUR REVERSE PROXY> # CHATGPT_REVERSE_PROXY=
##########################
# Search:
##########################
############################# # ENABLING SEARCH MESSAGES/CONVOS
# Search: # Requires the installation of the free self-hosted Meilisearch or a paid Remote Plan (Remote not tested)
############################# # The easiest setup for this is through docker-compose, which takes care of it for you.
SEARCH=TRUE
# ENABLING SEARCH MESSAGES/CONVOS # REQUIRED FOR SEARCH: MeiliSearch Host, mainly for the API server to connect to the search server.
# Requires installation of free self-hosted Meilisearch or Paid Remote Plan (Remote not tested) # Replace '0.0.0.0' with 'meilisearch' if serving MeiliSearch with docker-compose.
# The easiest setup for this is through docker-compose, which takes care of it for you. MEILI_HOST=http://0.0.0.0:7700
# SEARCH=1
SEARCH=1
# REQUIRED FOR SEARCH: MeiliSearch Host, mainly for api server to connect to the search server. # REQUIRED FOR SEARCH: MeiliSearch HTTP Address, mainly for docker-compose to expose the search server.
# must replace '0.0.0.0' with 'meilisearch' if serving meilisearch with docker-compose # Replace '0.0.0.0' with 'meilisearch' if serving MeiliSearch with docker-compose.
# MEILI_HOST='http://meilisearch:7700' # <-- docker-compose (should already be setup on docker-compose.yml) MEILI_HTTP_ADDR=0.0.0.0:7700
MEILI_HOST='http://0.0.0.0:7700' # <-- local/remote
# REQUIRED FOR SEARCH: MeiliSearch HTTP Address, mainly for docker-compose to expose the search server. # REQUIRED FOR SEARCH: In production env., a secure key is needed. You can generate your own.
# must replace '0.0.0.0' with 'meilisearch' if serving meilisearch with docker-compose # This master key must be at least 16 bytes, composed of valid UTF-8 characters.
# MEILI_HTTP_ADDR='meilisearch:7700' # <-- docker-compose (should already be setup on docker-compose.yml) # MeiliSearch will throw an error and refuse to launch if no master key is provided,
MEILI_HTTP_ADDR='0.0.0.0:7700' # <-- local/remote # or if it is under 16 bytes. MeiliSearch will suggest a secure autogenerated master key.
# REQUIRED FOR SEARCH: In production env., needs a secure key, feel free to generate your own.
# This master key must be at least 16 bytes, composed of valid UTF-8 characters.
# Meilisearch will throw an error and refuse to launch if no master key is provided or if it is under 16 bytes,
# Meilisearch will suggest a secure autogenerated master key.
# Using docker, it seems recognized as production so use a secure key. # Using docker, it seems recognized as production so use a secure key.
# MEILI_MASTER_KEY= # <-- empty/insecure key works for local/remote # This is a ready made secure key for docker-compose, you can replace it with your own.
MEILI_MASTER_KEY=JKMW-hGc7v_D1FkJVdbRSDNFLZcUv3S75yrxXP0SmcU # <-- ready made secure key for docker-compose MEILI_MASTER_KEY=JKMW-hGc7v_D1FkJVdbRSDNFLZcUv3S75yrxXP0SmcU
##########################
#############################
# User System # User System
############################# ##########################
# Enable the user system. # ENABLING THE USER SYSTEM
# this is not a ready to use user system. # This is not a ready to use user system.
# dont't use it, unless you can write your own code. # Don't use it, unless you can write your own code.
# ENABLE_USER_SYSTEM= # <-- make sure you don't comment this back in if you're not using your own user system # Do not uncomment this unless you implemented your own user system
# ENABLE_USER_SYSTEM=