Skip to content

Commit 7dd667c

Browse files
danny-aviladanny-avila
authored
Merge pull request danny-avila#187 from fuegovic/main
Update .env.example
2 parents 5cbbbdc + f063851 commit 7dd667c

File tree

1 file changed

+77
-82
lines changed

1 file changed

+77
-82
lines changed

‎api/.env.example

Lines changed: 77 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -1,112 +1,107 @@
1+
##########################
12
# Server configuration.
2-
# The server will listen to localhost:3080 request by default. You can set the target ip as you want.
3-
# If you want this server can be used outside your local machine, for example to share with other
4-
# machine or expose this from a docker container, set HOST=0.0.0.0 or your external ip interface.
5-
#
6-
# Tips: HOST=0.0.0.0 means listening on all interface. It's not a real ip. Use localhost:port rather
7-
# than 0.0.0.0:port to open it.
8-
HOST=localhost
3+
##########################
4+
5+
# The server will listen to localhost:3080 by default. You can change the target IP as you want.
6+
# If you want to make this server available externally, for example to share the server with others
7+
# or expose this from a Docker container, set host to 0.0.0.0 or your external IP interface.
8+
# Tips: Setting host to 0.0.0.0 means listening on all interfaces. It's not a real IP.
9+
# Use localhost:port rather than 0.0.0.0:port to access the server.
10+
HOST=localhost
911
PORT=3080
1012
NODE_ENV=development
1113

12-
# Change this to proxy any API request. It's useful if your machine have difficulty calling the original API server.
13-
# PROXY="http://YOUR_PROXY_SERVER"
14+
# Change this to proxy any API request.
15+
# It's useful if your machine has difficulty calling the original API server.
16+
# PROXY=
1417

15-
# Change this to your MongoDB URI if different and I recommend appending chatgpt-clone
16-
MONGO_URI="mongodb://127.0.0.1:27017/chatgpt-clone"
18+
# Change this to your MongoDB URI if different and I recommend appending chatgpt-clone
19+
MONGO_URI=mongodb://127.0.0.1:27017/chatgpt-clone
1720

21+
##########################
22+
# OpenAI Endpoint:
23+
##########################
1824

19-
#############################
20-
# Endpoint OpenAI:
21-
#############################
22-
23-
# Access key from OpenAI platform
24-
# Leave it blank to disable this endpoint
25+
# Access key from OpenAI platform.
26+
# Leave it blank to disable this feature.
2527
OPENAI_KEY=
2628

27-
# Identify the available models, sperate by comma, and not space in it
28-
# The first will be default
29-
# Leave it blank to use internal settings.
29+
# Identify the available models, separated by commas *without spaces*.
30+
# The first will be default.
31+
# Leave it blank to use internal settings.
3032
OPENAI_MODELS=gpt-3.5-turbo,gpt-3.5-turbo-0301,text-davinci-003,gpt-4
3133

32-
# Reverse proxy setting for OpenAI
33-
# https://github.com/waylaidwanderer/node-chatgpt-api#using-a-reverse-proxy
34-
# OPENAI_REVERSE_PROXY=<YOUR REVERSE PROXY>
34+
# Reverse proxy settings for OpenAI:
35+
# https://github.com/waylaidwanderer/node-chatgpt-api#using-a-reverse-proxy
36+
# OPENAI_REVERSE_PROXY=
3537

38+
##########################
39+
# BingAI Endpoint:
40+
##########################
3641

37-
#############################
38-
# Endpoint BingAI (Also jailbreak Sydney):
39-
#############################
42+
# Also used for Sydney and jailbreak
4043

41-
# BingAI Tokens: the "_U" cookies value from bing.com
42-
# Leave it and BINGAI_USER_TOKEN blank to disable this endpoint.
43-
# Set to "user_provided" to allow user provided token.
44-
# BINGAI_TOKEN="user_provided"
44+
# BingAI Tokens: the "_U" cookies value from bing.com
45+
# Set to "user_provided" to allow the user to provide its token from the UI.
46+
# Leave it blank to disable this endpoint.
4547
BINGAI_TOKEN=user_provided
4648

47-
# BingAI Host:
48-
# Necessary for some people in different countries, e.g. China (https://cn.bing.com)
49-
# Leave it blank to use default server.
50-
# BINGAI_HOST="https://cn.bing.com"
51-
49+
# BingAI Host:
50+
# Necessary for some people in different countries, e.g. China (https://cn.bing.com)
51+
# Leave it blank to use default server.
52+
# BINGAI_HOST=https://cn.bing.com
5253

53-
#############################
54-
# Endpoint chatGPT:
55-
#############################
54+
##########################
55+
# ChatGPT Endpoint:
56+
##########################
5657

57-
# ChatGPT Browser Client (free but use at your own risk)
58-
# Access token from https://chat.openai.com/api/auth/session
59-
# Exposes your access token to CHATGPT_REVERSE_PROXY
60-
# Leave it blank to disable this endpoint
61-
# Set to "user_provide" to allow user provided token.
62-
# CHATGPT_TOKEN="user_provide"
63-
CHATGPT_TOKEN=
58+
# ChatGPT Browser Client (free but use at your own risk)
59+
# Access token from https://chat.openai.com/api/auth/session
60+
# Exposes your access token to `CHATGPT_REVERSE_PROXY`
61+
# Set to "user_provided" to allow the user to provide its token from the UI.
62+
# Leave it blank to disable this endpoint
63+
CHATGPT_TOKEN=user_provided
6464

65-
# Identify the available models, sperate by comma, and not space in it
66-
# The first will be default
67-
# Leave it blank to use internal settings.
65+
# Identify the available models, separated by commas. The first will be default.
66+
# Leave it blank to use internal settings.
6867
CHATGPT_MODELS=text-davinci-002-render-sha,text-davinci-002-render-paid,gpt-4
6968

70-
# Reverse proxy setting for OpenAI
71-
# https://github.com/waylaidwanderer/node-chatgpt-api#using-a-reverse-proxy
72-
# By default it will use the node-chatgpt-api recommended proxy, (it's a third party server)
73-
# CHATGPT_REVERSE_PROXY=<YOUR REVERSE PROXY>
69+
# Reverse proxy settings for ChatGPT
70+
# https://github.com/waylaidwanderer/node-chatgpt-api#using-a-reverse-proxy
71+
# By default, the server will use the node-chatgpt-api recommended proxy (a third party server).
72+
# CHATGPT_REVERSE_PROXY=
7473

74+
##########################
75+
# Search:
76+
##########################
7577

76-
#############################
77-
# Search:
78-
#############################
78+
# ENABLING SEARCH MESSAGES/CONVOS
79+
# Requires the installation of the free self-hosted Meilisearch or a paid Remote Plan (Remote not tested)
80+
# The easiest setup for this is through docker-compose, which takes care of it for you.
81+
SEARCH=TRUE
7982

80-
# ENABLING SEARCH MESSAGES/CONVOS
81-
# Requires installation of free self-hosted Meilisearch or Paid Remote Plan (Remote not tested)
82-
# The easiest setup for this is through docker-compose, which takes care of it for you.
83-
# SEARCH=1
84-
SEARCH=1
83+
# REQUIRED FOR SEARCH: MeiliSearch Host, mainly for the API server to connect to the search server.
84+
# Replace '0.0.0.0' with 'meilisearch' if serving MeiliSearch with docker-compose.
85+
MEILI_HOST=http://0.0.0.0:7700
8586

86-
# REQUIRED FOR SEARCH: MeiliSearch Host, mainly for api server to connect to the search server.
87-
# must replace '0.0.0.0' with 'meilisearch' if serving meilisearch with docker-compose
88-
# MEILI_HOST='http://meilisearch:7700' # <-- docker-compose (should already be setup on docker-compose.yml)
89-
MEILI_HOST='http://0.0.0.0:7700' # <-- local/remote
87+
# REQUIRED FOR SEARCH: MeiliSearch HTTP Address, mainly for docker-compose to expose the search server.
88+
# Replace '0.0.0.0' with 'meilisearch' if serving MeiliSearch with docker-compose.
89+
MEILI_HTTP_ADDR=0.0.0.0:7700
9090

91-
# REQUIRED FOR SEARCH: MeiliSearch HTTP Address, mainly for docker-compose to expose the search server.
92-
# must replace '0.0.0.0' with 'meilisearch' if serving meilisearch with docker-compose
93-
# MEILI_HTTP_ADDR='meilisearch:7700' # <-- docker-compose (should already be setup on docker-compose.yml)
94-
MEILI_HTTP_ADDR='0.0.0.0:7700' # <-- local/remote
95-
96-
# REQUIRED FOR SEARCH: In production env., needs a secure key, feel free to generate your own.
97-
# This master key must be at least 16 bytes, composed of valid UTF-8 characters.
98-
# Meilisearch will throw an error and refuse to launch if no master key is provided or if it is under 16 bytes,
99-
# Meilisearch will suggest a secure autogenerated master key.
91+
# REQUIRED FOR SEARCH: In production env., a secure key is needed. You can generate your own.
92+
# This master key must be at least 16 bytes, composed of valid UTF-8 characters.
93+
# MeiliSearch will throw an error and refuse to launch if no master key is provided,
94+
# or if it is under 16 bytes. MeiliSearch will suggest a secure autogenerated master key.
10095
# Using docker, it seems recognized as production so use a secure key.
101-
# MEILI_MASTER_KEY= # <-- empty/insecure key works for local/remote
102-
MEILI_MASTER_KEY=JKMW-hGc7v_D1FkJVdbRSDNFLZcUv3S75yrxXP0SmcU # <-- ready made secure key for docker-compose
103-
96+
# This is a ready made secure key for docker-compose, you can replace it with your own.
97+
MEILI_MASTER_KEY=JKMW-hGc7v_D1FkJVdbRSDNFLZcUv3S75yrxXP0SmcU
10498

105-
#############################
99+
##########################
106100
# User System
107-
#############################
101+
##########################
108102

109-
# Enable the user system.
110-
# this is not a ready to use user system.
111-
# dont't use it, unless you can write your own code.
112-
# ENABLE_USER_SYSTEM= # <-- make sure you don't comment this back in if you're not using your own user system
103+
# ENABLING THE USER SYSTEM
104+
# This is not a ready to use user system.
105+
# Don't use it, unless you can write your own code.
106+
# Do not uncomment this unless you implemented your own user system
107+
# ENABLE_USER_SYSTEM=

0 commit comments

Comments
 (0)