From 86040304045547b664645c9760fe971dc0a6f2a0 Mon Sep 17 00:00:00 2001
From: Wentao Lyu <35-wentao.lyu@users.noreply.git.stereye.tech>
Date: Sat, 11 Mar 2023 15:03:18 +0800
Subject: [PATCH] Add more information in env.example. Give current host
 address when HOST=0.0.0.0

---
 api/.env.example    | 23 ++++++++++++++++-------
 api/server/index.js |  5 ++++-
 2 files changed, 20 insertions(+), 8 deletions(-)

diff --git a/api/.env.example b/api/.env.example
index 14209cff03..e679f6a0e0 100644
--- a/api/.env.example
+++ b/api/.env.example
@@ -1,13 +1,22 @@
-OPENAI_KEY=
-HOST=
+# 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.
+#
+# Tips: HOST=0.0.0.0 means listening on all interface. It's not a real ip. Use localhost:port rather
+# than 0.0.0.0:port to open it.
+HOST=localhost 
 PORT=3080
 NODE_ENV=development
 
+# Change this to proxy any API request. It's useful if your machine have difficulty calling the original API server.
+# PROXY="http://YOUR_PROXY_SERVER"
+
 # Change this to your MongoDB URI if different and I recommend appending chatgpt-clone
 MONGO_URI="mongodb://127.0.0.1:27017/chatgpt-clone"
 
-# Change this to proxy any request.
-PROXY=
-
-CHATGPT_TOKEN=""
-BING_TOKEN=""
\ No newline at end of file
+# API key configuration.
+# Leave blank if you don't want them.
+OPENAI_KEY=
+CHATGPT_TOKEN=
+BING_TOKEN=
\ No newline at end of file
diff --git a/api/server/index.js b/api/server/index.js
index 5f65569b27..b380932531 100644
--- a/api/server/index.js
+++ b/api/server/index.js
@@ -25,5 +25,8 @@ app.use('/api/customGpts', routes.customGpts);
 app.use('/api/prompts', routes.prompts);
 
 app.listen(port, host,  () => {
-  console.log(`Server listening at http://${host}:${port}`);
+  if (host=='0.0.0.0')
+    console.log(`Server listening on all interface at port ${port}. Use http://localhost:${port} to access it`);
+  else
+    console.log(`Server listening at http://${host=='0.0.0.0'?'localhost':host}:${port}`);
 });
\ No newline at end of file