Skip to content

Commit

Permalink
📝 docs: Update README (lobehub#576)
Browse files Browse the repository at this point in the history
* Update README.md

* Update README.zh-CN.md

* Update Environment-Variable.md

* Update Environment-Variable.zh-CN.md
  • Loading branch information
arvinxx committed Dec 4, 2023
1 parent 247c074 commit cc34c98
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -393,7 +393,7 @@ This project provides some additional configuration items set with environment v
| `OPENAI_API_KEY` | Yes | This is the API key you apply on the OpenAI account page | `sk-xxxxxx...xxxxxx` |
| `OPENAI_PROXY_URL` | No | If you manually configure the OpenAI interface proxy, you can use this configuration item to override the default OpenAI API request base URL | `https://api.chatanywhere.cn/v1`<br/>The default value is<br/>`https://api.openai.com/v1` |
| `OPENAI_FUNCTION_REGIONS` | No | When you deploy Lobe-Chat using Vercel and need to specify the region for the Edge Function that handles requests to the OpenAI API, you can use this configuration. The value should be a comma-separated array of strings. | `iad1,sfo1` |
| `ACCESS_CODE` | No | Add a password to access this service; the password should be a 6-digit number or letter | `awCT74` or `e3@09!` |
| `ACCESS_CODE` | No | Add a password to access this service; you can set a long password to avoid leaking | `awCTe)re_r74` or `rtrt_ewee3@09!` |

> \[!NOTE]
>
Expand Down
2 changes: 1 addition & 1 deletion README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -365,7 +365,7 @@ $ docker run -d -p 3210:3210 \
| `OPENAI_API_KEY` | 必选 | 这是你在 OpenAI 账户页面申请的 API 密钥 | `sk-xxxxxx...xxxxxx` |
| `OPENAI_PROXY_URL` | 可选 | 如果你手动配置了 OpenAI 接口代理,可以使用此配置项来覆盖默认的 OpenAI API 请求基础 URL | `https://api.chatanywhere.cn/v1`<br/>默认值:<br/>`https://api.openai.com/v1` |
| `OPENAI_FUNCTION_REGIONS` | 可选 | 当你使用 Vercel 部署 Lobe-Chat,而且有需求指定响应调用 OpenAI 接口的请求的 Edge Function 的 Region 时,可以使用该配置进行配置,该值的类型为逗号分隔的字符串数组 | `iad1,sfo1` |
| `ACCESS_CODE` | 可选 | 添加访问此服务的密码,密码应为 6 位数字或字母 | `awCT74``e3@09!` |
| `ACCESS_CODE` | 可选 | 添加访问此服务的密码,你可以设置一个长密码以防被爆破 | `awCTe)re_r74` or `rtrt_ewee3@09!` |

> \[!NOTE]
>
Expand Down
4 changes: 2 additions & 2 deletions docs/Environment-Variable.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ LobeChat provides additional configuration options during deployment, which can
### `ACCESS_CODE`

- Type: Optional
- Description: Add a password to access the LobeChat service, the password should be 6 digits or letters
- Description: Add a password to access the LobeChat service, ; you can set a long password to avoid leaking.
- Default: `-`
- Example: `awCT74` or `e3@09!`
- Example: `awCTe)re_r74` or `rtrt_ewee3@09!`

### `NEXT_PUBLIC_CUSTOM_MODELS`

Expand Down
4 changes: 2 additions & 2 deletions docs/Environment-Variable.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,9 @@ LobeChat 在部署时提供了一些额外的配置项,使用环境变量进
### `ACCESS_CODE`

- 类型:可选
- 描述:添加访问 LobeChat 服务的密码,密码应为 6 位数字或字母
- 描述:添加访问 LobeChat 服务的密码,你可以设置一个长密码以防被爆破
- 默认值:-
- 示例:`awCT74``e3@09!`
- 示例:`awCTe)re_r74` or `rtrt_ewee3@09!`

### `NEXT_PUBLIC_CUSTOM_MODELS`

Expand Down

0 comments on commit cc34c98

Please sign in to comment.