Skip to content

Commit 7bd68a3

Browse files
author
Kerwin
committed
docs: 减少初始环境变量
1 parent 378dac7 commit 7bd68a3

File tree

13 files changed

+30
-206
lines changed

13 files changed

+30
-206
lines changed

‎README.en.md

Lines changed: 4 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -240,57 +240,19 @@ services:
240240
- database
241241
environment:
242242
TZ: Asia/Shanghai
243-
# one of two
244-
OPENAI_API_KEY: xxxxxx
245-
# one of two
246-
OPENAI_ACCESS_TOKEN: xxxxxx
247-
# api interface url, optional, available when OPENAI_API_KEY is set
248-
OPENAI_API_BASE_URL: xxxx
249-
# ChatGPTAPI 或者 ChatGPTUnofficialProxyAPI
250-
OPENAI_API_MODEL: xxxx
251-
# reverse proxy, optional
252-
API_REVERSE_PROXY: xxx
253-
# timeout, in milliseconds, optional
254-
TIMEOUT_MS: 600000
255-
# socks proxy, optional, effective with SOCKS_PROXY_PORT
256-
SOCKS_PROXY_HOST: xxxx
257-
# socks proxy port, optional, effective with SOCKS_PROXY_HOST
258-
SOCKS_PROXY_PORT: xxxx
259-
# socks proxy, optional, effective with SOCKS_PROXY_HOST and SOCKS_PROXY_PORT
260-
SOCKS_PROXY_USERNAME: xxxx
261-
# socks proxy port, optional, effective with SOCKS_PROXY_HOST and SOCKS_PROXY_PORT
262-
SOCKS_PROXY_PASSWORD: xxxx
263-
# HTTPS Proxy，optional, support http, https, socks5
264-
HTTPS_PROXY: http://xxx:7890
265243
# Title for site
266244
SITE_TITLE: ChatGpt Web
267245
# access salt，optional Allow login if not empty.
268246
AUTH_SECRET_KEY: xxx
269247
# mongodb's connection string
270248
MONGODB_URL: 'mongodb://chatgpt:xxxx@database:27017'
271-
# Register enabled
272-
REGISTER_ENABLED: true
273-
# After register enabled, Allowed mailbox suffixes for website registration. If empty, any suffix is allowed
274-
REGISTER_MAILS: '@qq.com,@sina.com,@163.com'
275249
# After register enabled, Salt for password encryption
276250
PASSWORD_MD5_SALT: xxx
277251
# After register enabled, super administrator
278252
ROOT_USER: me@example.com
279-
# After register enabled, The website's domain ending without /
280-
SITE_DOMAIN: http://127.0.0.1:3002
281-
# After register enabled, The smtp settings
282-
SMTP_HOST: smtp.exmail.qq.com
283-
SMTP_PORT: 465
284-
SMTP_TSL: true
285-
SMTP_USERNAME: noreply@examile.com
286-
SMTP_PASSWORD: xxx
287-
# Enable sensitive word review, because the response result is streaming, so there is currently no review.
288-
AUDIT_ENABLED: false
289-
# https://ai.baidu.com/ai-doc/ANTIPORN/Vk3h6xaga
290-
AUDIT_PROVIDER: baidu
291-
AUDIT_API_KEY: xxx
292-
AUDIT_API_SECRET: xxx
293-
AUDIT_TEXT_LABEL: xxx
253+
# Allow anyone register, Must be turned on, otherwise administrators cannot register, can be turned off later.
254+
REGISTER_ENABLED: true
255+
# More configurations, register an administrator after running and set it in the administrator page.
294256
links:
295257
- database
296258

@@ -318,23 +280,7 @@ The `OPENAI_API_BASE_URL` is optional and only used when setting the `OPENAI_API
318280

319281
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template/yytmgc)
320282

321-
#### Railway Environment Variables
322-
323-
| Environment Variable | Required | Description |
324-
|------------------------|-------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
325-
| `PORT` | Required | Default: `3002` |
326-
| `AUTH_SECRET_KEY` | Optional | access password |
327-
| `TIMEOUT_MS` | Optional | Timeout in milliseconds |
328-
| `OPENAI_API_KEY` | Optional | Required for `OpenAI API`. `apiKey` can be obtained from [here](https://platform.openai.com/overview). |
329-
| `OPENAI_ACCESS_TOKEN` | Optional | Required for `Web API`. `accessToken` can be obtained from [here](https://chat.openai.com/api/auth/session). |
330-
| `OPENAI_API_BASE_URL` | Optional, only for `OpenAI API` | API endpoint. |
331-
| `OPENAI_API_MODEL` | `ChatGPTAPI` OR `ChatGPTUnofficialProxyAPI` | API model. |
332-
| `API_REVERSE_PROXY` | Optional, only for `Web API` | Reverse proxy address for `Web API`. [Details](https://github.com/transitive-bullshit/chatgpt-api#reverse-proxy) |
333-
| `SOCKS_PROXY_HOST` | Optional, effective with `SOCKS_PROXY_PORT` | Socks proxy. |
334-
| `SOCKS_PROXY_PORT` | Optional, effective with `SOCKS_PROXY_HOST` | Socks proxy port. |
335-
| `SOCKS_PROXY_USERNAME` | Optional, effective with `SOCKS_PROXY_HOST` & `SOCKS_PROXY_PORT` | Socks proxy username. |
336-
| `SOCKS_PROXY_PASSWORD` | Optional, effective with `SOCKS_PROXY_HOST` & `SOCKS_PROXY_PORT` | Socks proxy password. |
337-
| `HTTPS_PROXY` | Optional | HTTPS Proxy. |
283+
> Refer to this issue https://github.com/Kerwin1202/chatgpt-web/issues/266
338284

339285
> Note: Changing environment variables in Railway will cause re-deployment.
340286

‎README.md

Lines changed: 4 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -244,55 +244,21 @@ services:
244244
- database
245245
environment:
246246
TZ: Asia/Shanghai
247-
# 二选一
248-
OPENAI_API_KEY: sk-xxx
249-
# 二选一
250-
OPENAI_ACCESS_TOKEN: xxx
251-
# API接口地址，可选，设置 OPENAI_API_KEY 时可用
252-
OPENAI_API_BASE_URL: xxx
253-
# ChatGPTAPI ChatGPTUnofficialProxyAPI
254-
OPENAI_API_MODEL: ChatGPTAPI
255-
# 反向代理，可选
256-
API_REVERSE_PROXY: xxx
257247
# 每小时最大请求次数，可选，默认无限
258248
MAX_REQUEST_PER_HOUR: 0
259-
# 超时，单位毫秒，可选
260-
TIMEOUT_MS: 600000
261-
# Socks代理，可选，和 SOCKS_PROXY_PORT 一起时生效
262-
SOCKS_PROXY_HOST: xxx
263-
# Socks代理端口，可选，和 SOCKS_PROXY_HOST 一起时生效
264-
SOCKS_PROXY_PORT: xxx
265-
# HTTPS 代理，可选，支持 http，https，socks5
266-
HTTPS_PROXY: http://xxx:7890
267249
# 访问jwt加密参数，可选 不为空则允许登录 同时需要设置 MONGODB_URL
268250
AUTH_SECRET_KEY: xxx
269251
# 网站名称
270252
SITE_TITLE: ChatGpt Web
271253
# mongodb 的连接字符串
272254
MONGODB_URL: 'mongodb://chatgpt:xxxx@database:27017'
273-
# 网站是否开启注册
274-
REGISTER_ENABLED: 'true'
275-
# 开启注册之后 网站注册允许的邮箱后缀 如果空 则允许任意后缀
276-
REGISTER_MAILS: '@qq.com,@sina.com,@163.com'
277255
# 开启注册之后 密码加密的盐
278256
PASSWORD_MD5_SALT: xxx
279257
# 开启注册之后 超级管理邮箱
280258
ROOT_USER: me@example.com
281-
# 开启注册之后 网站域名 不含 / 注册的时候发送验证邮箱使用
282-
SITE_DOMAIN: http://127.0.0.1:3002
283-
# 开启注册之后 发送验证邮箱配置
284-
SMTP_HOST: smtp.exmail.qq.com
285-
SMTP_PORT: 465
286-
SMTP_TSL: 'true'
287-
SMTP_USERNAME: noreply@examile.com
288-
SMTP_PASSWORD: xxx
289-
# 是否开启敏感词审核, 因为响应结果是流式 所以暂时没审核
290-
AUDIT_ENABLED: 'false'
291-
# https://ai.baidu.com/ai-doc/ANTIPORN/Vk3h6xaga
292-
AUDIT_PROVIDER: baidu
293-
AUDIT_API_KEY: xxx
294-
AUDIT_API_SECRET: xxx
295-
AUDIT_TEXT_LABEL: xxx
259+
# 网站是否开启注册 必须开启, 否则管理员都没法注册, 可后续关闭
260+
REGISTER_ENABLED: true
261+
# 更多配置, 在运行后, 注册管理员, 在管理员页面中设置
296262
links:
297263
- database
298264

@@ -333,24 +299,7 @@ volumes:
333299
334300
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template/yytmgc)
335301
336-
#### Railway 环境变量
337-
338-
| 环境变量名称 | 必填 | 备注 |
339-
| --------------------- | ---------------------- | -------------------------------------------------------------------------------------------------- |
340-
| `PORT` | 必填 | 默认 `3002`
341-
| `AUTH_SECRET_KEY` | 可选 | 访问权限密钥 |
342-
| `MAX_REQUEST_PER_HOUR` | 可选 | 每小时最大请求次数，可选，默认无限 |
343-
| `TIMEOUT_MS` | 可选 | 超时时间，单位毫秒 |
344-
| `OPENAI_API_KEY` | `OpenAI API` 二选一 | 使用 `OpenAI API` 所需的 `apiKey` [(获取 apiKey)](https://platform.openai.com/overview) |
345-
| `OPENAI_ACCESS_TOKEN` | `Web API` 二选一 | 使用 `Web API` 所需的 `accessToken` [(获取 accessToken)](https://chat.openai.com/api/auth/session) |
346-
| `OPENAI_API_BASE_URL` | 可选，`OpenAI API` 时可用 | `API`接口地址 |
347-
| `OPENAI_API_MODEL` | ChatGPTAPI OR ChatGPTUnofficialProxyAPI | `API`模型 |
348-
| `API_REVERSE_PROXY` | 可选，`Web API` 时可用 | `Web API` 反向代理地址 [详情](https://github.com/transitive-bullshit/chatgpt-api#reverse-proxy) |
349-
| `SOCKS_PROXY_HOST` | 可选，和 `SOCKS_PROXY_PORT` 一起时生效 | Socks代理 |
350-
| `SOCKS_PROXY_PORT` | 可选，和 `SOCKS_PROXY_HOST` 一起时生效 | Socks代理端口 |
351-
| `SOCKS_PROXY_USERNAME` | 可选，和 `SOCKS_PROXY_HOST` 一起时生效 | Socks代理用户名 |
352-
| `SOCKS_PROXY_PASSWORD` | 可选，和 `SOCKS_PROXY_HOST` 一起时生效 | Socks代理密码 |
353-
| `HTTPS_PROXY` | 可选 | HTTPS 代理，支持 http，https, socks5 |
302+
> 参考这个 issue 详细教程 https://github.com/Kerwin1202/chatgpt-web/issues/266
354303
355304
> 注意: `Railway` 修改环境变量会重新 `Deploy`
356305

‎docker-compose/docker-compose.yml

Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -15,43 +15,17 @@ services:
1515
AUTH_SECRET_KEY:
1616
# 每小时最大请求次数，可选，默认无限
1717
MAX_REQUEST_PER_HOUR: 0
18-
# 超时，单位毫秒，可选
19-
TIMEOUT_MS: 600000
20-
# Socks代理，可选，和 SOCKS_PROXY_PORT 一起时生效
21-
SOCKS_PROXY_HOST:
22-
# Socks代理端口，可选，和 SOCKS_PROXY_HOST 一起时生效
23-
SOCKS_PROXY_PORT:
24-
# Socks代理用户名，可选，和 SOCKS_PROXY_HOST & SOCKS_PROXY_PORT 一起时生效
25-
SOCKS_PROXY_USERNAME:
26-
# Socks代理密码，可选，和 SOCKS_PROXY_HOST & SOCKS_PROXY_PORT 一起时生效
27-
SOCKS_PROXY_PASSWORD:
2818
# 网站名称
2919
SITE_TITLE: ChatGpt Web
3020
# mongodb 的连接字符串
3121
MONGODB_URL: 'mongodb://chatgpt:xxxx@database:27017'
32-
# 网站是否开启注册
33-
REGISTER_ENABLED: false
34-
# 开启注册之后 网站注册允许的邮箱后缀 如果空 则允许任意后缀
35-
REGISTER_MAILS: '@qq.com,@sina.com,@163.com'
3622
# 开启注册之后 密码加密的盐
3723
PASSWORD_MD5_SALT: anysalt
3824
# 开启注册之后 超级管理邮箱
3925
ROOT_USER: xxx@qq.com
40-
# 开启注册之后 网站域名 不含 / 注册的时候发送验证邮箱使用
41-
SITE_DOMAIN: http://127.0.0.1:1002
42-
# 开启注册之后 发送验证邮箱配置
43-
SMTP_HOST: smtp.exmail.qq.com
44-
SMTP_PORT: 465
45-
SMTP_TSL: true
46-
SMTP_USERNAME: ${SMTP_USERNAME}
47-
SMTP_PASSWORD: ${SMTP_PASSWORD}
48-
# 是否开启敏感词审核, 因为响应结果是流式 所以暂时没审核
49-
AUDIT_ENABLED: false
50-
# https://ai.baidu.com/ai-doc/ANTIPORN/Vk3h6xaga
51-
AUDIT_PROVIDER: baidu
52-
AUDIT_API_KEY:
53-
AUDIT_API_SECRET:
54-
AUDIT_TEXT_LABEL:
26+
# 网站是否开启注册 必须开启, 否则管理员都没法注册, 可后续关闭
27+
REGISTER_ENABLED: true
28+
# 更多配置, 在运行后, 注册管理员, 在管理员页面中设置
5529
links:
5630
- database
5731

‎service/.env.example

Lines changed: 6 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,12 @@
1-
# OpenAI API Key - https://platform.openai.com/overview
2-
OPENAI_API_KEY=
3-
4-
# change this to an `accessToken` extracted from the ChatGPT site's `https://chat.openai.com/api/auth/session` response
5-
OPENAI_ACCESS_TOKEN=
6-
7-
# OpenAI API Base URL - https://api.openai.com
8-
OPENAI_API_BASE_URL=
9-
10-
# ChatGPTAPI 或者 ChatGPTUnofficialProxyAPI
11-
OPENAI_API_MODEL:
12-
131
# set `true` to disable OpenAI API debug log
142
OPENAI_API_DISABLE_DEBUG=
153

16-
# Reverse Proxy - Available on accessToken
17-
# Default: https://ai.fakeopen.com/api/conversation
18-
# More: https://github.com/transitive-bullshit/chatgpt-api#reverse-proxy
19-
API_REVERSE_PROXY=
20-
21-
# timeout
22-
TIMEOUT_MS=100000
23-
244
# Rate Limit
255
MAX_REQUEST_PER_HOUR=
266

277
# Auth Rate Limit
288
AUTH_MAX_REQUEST_PER_MINUTE=5
299

30-
# Socks Proxy Host
31-
SOCKS_PROXY_HOST=
32-
33-
# Socks Proxy Port
34-
SOCKS_PROXY_PORT=
35-
36-
# Socks Proxy Username
37-
SOCKS_PROXY_USERNAME=
38-
39-
# Socks Proxy Password
40-
SOCKS_PROXY_PASSWORD=
41-
42-
# HTTPS PROXY
43-
HTTPS_PROXY=
44-
4510
# Title for site
4611
SITE_TITLE="ChatGpt Web"
4712

@@ -55,31 +20,17 @@ AUTH_SECRET_KEY=
5520

5621
# ----- Only valid after setting AUTH_SECRET_KEY begin ----
5722

58-
# Allow anyone register
59-
REGISTER_ENABLED=false
60-
61-
# Enable register application review
62-
REGISTER_REVIEW=false
63-
64-
# The site domain, Only for registration account verification
65-
# without end /
66-
SITE_DOMAIN=http://127.0.0.1:1002
67-
68-
# Allowed Email Providers, If it is empty, any mailbox is allowed
69-
# REGISTER_MAILS=@qq.com,@sina.com,@163.com
70-
REGISTER_MAILS=@qq.com,@sina.com,@163.com
71-
7223
# The roon user only email
7324
ROOT_USER=
7425

7526
# Password salt
7627
PASSWORD_MD5_SALT=anysalt
7728

78-
# User register email verify
79-
SMTP_HOST=smtp.exmail.qq.com
80-
SMTP_PORT=465
81-
SMTP_TSL=true
82-
SMTP_USERNAME=yourname@example.com
83-
SMTP_PASSWORD=yourpassword
29+
# Allow anyone register, Must be turned on, otherwise administrators cannot register, can be turned off later.
30+
REGISTER_ENABLED=true
8431

8532
# ----- Only valid after setting AUTH_SECRET_KEY end ----
33+
34+
35+
# 更多配置, 在运行后, 注册管理员, 在管理员页面中设置
36+
# More configurations, register an administrator after running and set it in the administrator page.

‎service/src/storage/config.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,12 @@ export async function getOriginConfig() {
2727
let config = await getConfig()
2828
if (config == null) {
2929
config = new Config(new ObjectId(),
30-
!isNaN(+process.env.TIMEOUT_MS) ? +process.env.TIMEOUT_MS : 30 * 1000,
30+
!isNaN(+process.env.TIMEOUT_MS) ? +process.env.TIMEOUT_MS : 600 * 1000,
3131
process.env.OPENAI_API_KEY,
3232
process.env.OPENAI_API_DISABLE_DEBUG === 'true',
3333
process.env.OPENAI_ACCESS_TOKEN,
3434
process.env.OPENAI_API_BASE_URL,
35-
process.env.OPENAI_API_MODEL || 'ChatGPTAPI',
35+
process.env.OPENAI_API_MODEL === 'ChatGPTUnofficialProxyAPI' ? 'ChatGPTUnofficialProxyAPI' : 'ChatGPTAPI',
3636
process.env.API_REVERSE_PROXY,
3737
(process.env.SOCKS_PROXY_HOST && process.env.SOCKS_PROXY_PORT)
3838
? (`${process.env.SOCKS_PROXY_HOST}:${process.env.SOCKS_PROXY_PORT}`)

‎src/components/common/Setting/About.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ onMounted(() => {
6868
<div class="flex items-center space-x-4">
6969
<span class="flex-shrink-0 w-[100px]">{{ $t('setting.socks') }}</span>
7070
<div class="flex-1">
71-
<NInput :value="config.socksProxy" placeholder="" @input="(val) => { config.socksProxy = val }" />
71+
<NInput :value="config.socksProxy" placeholder="ip:port" @input="(val) => { config.socksProxy = val }" />
7272
</div>
7373
</div>
7474
<div class="flex items-center space-x-4">

‎src/components/common/Setting/Keys.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ const columns = [
102102
type: 'info',
103103
onClick: () => handleEditKey(row),
104104
},
105-
{ default: () => t('chat.editKeyButton') },
105+
{ default: () => t('common.edit') },
106106
))
107107
actions.push(h(
108108
NButton,
@@ -114,7 +114,7 @@ const columns = [
114114
type: 'error',
115115
onClick: () => handleUpdateApiKeyStatus(row._id as string, Status.Disabled),
116116
},
117-
{ default: () => t('chat.deleteKey') },
117+
{ default: () => t('common.delete') },
118118
))
119119
}
120120
return actions

‎src/components/common/Setting/Site.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ onMounted(() => {
112112
<span class="flex-shrink-0 w-[100px]">{{ $t('setting.registerMails') }}</span>
113113
<div class="flex-1">
114114
<NInput
115-
:value="config && config.registerMails" placeholder=""
115+
:value="config && config.registerMails" :placeholder="$t('setting.registerReviewTip')"
116116
@input="(val) => { if (config) config.registerMails = val }"
117117
/>
118118
</div>

‎src/components/common/Setting/User.vue

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ const columns = [
8181
},
8282
onClick: () => handleUpdateUserStatus(row._id, Status.Deleted),
8383
},
84-
{ default: () => t('chat.deleteUser') },
84+
{ default: () => t('common.delete') },
8585
))
8686
if (row.status === Status.Normal) {
8787
actions.push(h(
@@ -90,7 +90,7 @@ const columns = [
9090
size: 'small',
9191
type: 'primary',
9292
style: {
93-
marginRight: '6px',
93+
marginRight: '8px',
9494
},
9595
onClick: () => handleEditUser(row),
9696
},

‎src/locales/en-US.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ export default {
114114
registerEnabled: 'Register Enabled',
115115
registerReview: 'Register Review',
116116
registerMails: 'Register Mails',
117+
registerReviewTip: 'Only email addresses with these suffixes are allowed to register on this website.',
117118
apiBaseUrl: 'Api Base Url',
118119
apiModel: 'Api Model',
119120
accessToken: 'Access Token',

‎src/locales/ko-KR.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,7 @@ export default {
112112
registerEnabled: '등록 활성화',
113113
registerReview: '등록 리뷰',
114114
registerMails: '메일 등록',
115+
registerReviewTip: 'Only email addresses with these suffixes are allowed to register on this website.',
115116
apiBaseUrl: 'API 베이스 URL',
116117
apiModel: '인터페이스 유형',
117118
accessToken: '액세스 토큰',

‎src/locales/zh-CN.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,7 @@ export default {
114114
registerEnabled: '新用户',
115115
registerReview: '新用户审核',
116116
registerMails: '邮箱后缀',
117+
registerReviewTip: '仅允许这些邮箱的后缀注册本网站',
117118
apiBaseUrl: '接口地址',
118119
apiModel: '接口类型',
119120
accessToken: 'Access Token',

0 commit comments

Comments
 (0)