Files
chatgpt-ui/zh/guide/configuration.html
github-actions[bot] 3360252d06 Deploy to GitHub pages
2023-04-18 02:45:52 +00:00

46 lines
19 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="generator" content="VuePress 2.0.0-beta.61">
<style>
:root {
--c-bg: #fff;
}
html.dark {
--c-bg: #22272e;
}
html, body {
background-color: var(--c-bg);
}
</style>
<script>
const userMode = localStorage.getItem('vuepress-color-scheme');
const systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;
if (userMode === 'dark' || (userMode !== 'light' && systemDarkMode)) {
document.documentElement.classList.toggle('dark', true);
}
</script>
<title>配置参考 | ChatGPT UI</title><meta name="description" content="一个 ChatGPT 的 Web 客户端">
<link rel="preload" href="/chatgpt-ui/assets/style-ad6949cb.css" as="style"><link rel="stylesheet" href="/chatgpt-ui/assets/style-ad6949cb.css">
<link rel="modulepreload" href="/chatgpt-ui/assets/app-525ee8ad.js"><link rel="modulepreload" href="/chatgpt-ui/assets/framework-5866ffd3.js"><link rel="modulepreload" href="/chatgpt-ui/assets/configuration.html-99825d43.js"><link rel="modulepreload" href="/chatgpt-ui/assets/configuration.html-0ef661b4.js"><link rel="prefetch" href="/chatgpt-ui/assets/index.html-f32af385.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/buymeacoffee.html-f20ec2fb.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/configuration.html-ed512da6.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/development.html-117eb2b5.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/problems.html-3485ea96.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/quick-start.html-5d24620c.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/index.html-a9203641.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/buymeacoffee.html-22a781eb.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/development.html-b8d21bb5.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/problems.html-f1039fc4.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/quick-start.html-91a3ce5d.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/404.html-60b35caa.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/index.html-18d42ac0.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/buymeacoffee.html-138309cb.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/configuration.html-a7684ba6.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/development.html-df5e9336.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/problems.html-84e6145b.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/quick-start.html-b336d0c1.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/index.html-d042d854.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/buymeacoffee.html-5158290f.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/development.html-989a2b06.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/problems.html-dabd58d0.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/quick-start.html-fc1bc91c.js" as="script"><link rel="prefetch" href="/chatgpt-ui/assets/404.html-87d54bd8.js" as="script">
</head>
<body>
<div id="app"><!--[--><div class="theme-container"><!--[--><header class="navbar"><div class="toggle-sidebar-button" title="切换侧边栏" aria-expanded="false" role="button" tabindex="0"><div class="icon" aria-hidden="true"><span></span><span></span><span></span></div></div><span><a href="/chatgpt-ui/zh/" class=""><!----><span class="site-name">ChatGPT UI</span></a></span><div class="navbar-items-wrapper" style=""><!--[--><!--]--><nav class="navbar-items can-hide"><!--[--><div class="navbar-item"><a href="/chatgpt-ui/zh/" class="" aria-label="指南"><!--[--><!--]--> 指南 <!--[--><!--]--></a></div><div class="navbar-item"><a class="external-link" href="https://github.com/WongSaang/chatgpt-ui/releases" rel="noopener noreferrer" target="_blank" aria-label="更新日志"><!--[--><!--]--> 更新日志 <span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">在新窗口打开</span></span><!--[--><!--]--></a></div><div class="navbar-item"><div class="navbar-dropdown-wrapper"><button class="navbar-dropdown-title" type="button" aria-label="选择语言"><span class="title">选择语言</span><span class="arrow down"></span></button><button class="navbar-dropdown-title-mobile" type="button" aria-label="选择语言"><span class="title">选择语言</span><span class="right arrow"></span></button><ul style="display:none;" class="navbar-dropdown"><!--[--><li class="navbar-dropdown-item"><a href="/chatgpt-ui/guide/configuration.html" class="" aria-label="English"><!--[--><!--]--> English <!--[--><!--]--></a></li><li class="navbar-dropdown-item"><a aria-current="page" href="/chatgpt-ui/zh/guide/configuration.html" class="router-link-active router-link-exact-active router-link-active" aria-label="简体中文"><!--[--><!--]--> 简体中文 <!--[--><!--]--></a></li><!--]--></ul></div></div><!--]--></nav><!--[--><!--]--><button class="toggle-color-mode-button" title="切换颜色模式"><svg style="" class="icon" focusable="false" viewBox="0 0 32 32"><path d="M16 12.005a4 4 0 1 1-4 4a4.005 4.005 0 0 1 4-4m0-2a6 6 0 1 0 6 6a6 6 0 0 0-6-6z" fill="currentColor"></path><path d="M5.394 6.813l1.414-1.415l3.506 3.506L8.9 10.318z" fill="currentColor"></path><path d="M2 15.005h5v2H2z" fill="currentColor"></path><path d="M5.394 25.197L8.9 21.691l1.414 1.415l-3.506 3.505z" fill="currentColor"></path><path d="M15 25.005h2v5h-2z" fill="currentColor"></path><path d="M21.687 23.106l1.414-1.415l3.506 3.506l-1.414 1.414z" fill="currentColor"></path><path d="M25 15.005h5v2h-5z" fill="currentColor"></path><path d="M21.687 8.904l3.506-3.506l1.414 1.415l-3.506 3.505z" fill="currentColor"></path><path d="M15 2.005h2v5h-2z" fill="currentColor"></path></svg><svg style="display:none;" class="icon" focusable="false" viewBox="0 0 32 32"><path d="M13.502 5.414a15.075 15.075 0 0 0 11.594 18.194a11.113 11.113 0 0 1-7.975 3.39c-.138 0-.278.005-.418 0a11.094 11.094 0 0 1-3.2-21.584M14.98 3a1.002 1.002 0 0 0-.175.016a13.096 13.096 0 0 0 1.825 25.981c.164.006.328 0 .49 0a13.072 13.072 0 0 0 10.703-5.555a1.01 1.01 0 0 0-.783-1.565A13.08 13.08 0 0 1 15.89 4.38A1.015 1.015 0 0 0 14.98 3z" fill="currentColor"></path></svg></button><!----></div></header><!--]--><div class="sidebar-mask"></div><!--[--><aside class="sidebar"><nav class="navbar-items"><!--[--><div class="navbar-item"><a href="/chatgpt-ui/zh/" class="" aria-label="指南"><!--[--><!--]--> 指南 <!--[--><!--]--></a></div><div class="navbar-item"><a class="external-link" href="https://github.com/WongSaang/chatgpt-ui/releases" rel="noopener noreferrer" target="_blank" aria-label="更新日志"><!--[--><!--]--> 更新日志 <span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">在新窗口打开</span></span><!--[--><!--]--></a></div><div class="navbar-item"><div class="navbar-dropdown-wrapper"><button class="navbar-dropdown-title" type="button" aria-label="选择语言"><span class="title">选择语言</span><span class="arrow down"></span></button><button class="navbar-dropdown-title-mobile" type="button" aria-label="选择语言"><span class="title">选择语言</span><span class="right arrow"></span></button><ul style="display:none;" class="navbar-dropdown"><!--[--><li class="navbar-dropdown-item"><a href="/chatgpt-ui/guide/configuration.html" class="" aria-label="English"><!--[--><!--]--> English <!--[--><!--]--></a></li><li class="navbar-dropdown-item"><a aria-current="page" href="/chatgpt-ui/zh/guide/configuration.html" class="router-link-active router-link-exact-active router-link-active" aria-label="简体中文"><!--[--><!--]--> 简体中文 <!--[--><!--]--></a></li><!--]--></ul></div></div><!--]--></nav><!--[--><!--]--><ul class="sidebar-items"><!--[--><li><p tabindex="0" class="sidebar-item sidebar-heading active">指南 <!----></p><ul style="" class="sidebar-item-children"><!--[--><li><a href="/chatgpt-ui/zh/" class="sidebar-item" aria-label="介绍"><!--[--><!--]--> 介绍 <!--[--><!--]--></a><!----></li><li><a href="/chatgpt-ui/zh/guide/quick-start.html" class="sidebar-item" aria-label="快速开始"><!--[--><!--]--> 快速开始 <!--[--><!--]--></a><!----></li><li><a aria-current="page" href="/chatgpt-ui/zh/guide/configuration.html" class="router-link-active router-link-exact-active router-link-active sidebar-item active" aria-label="配置参考"><!--[--><!--]--> 配置参考 <!--[--><!--]--></a><ul style="" class="sidebar-item-children"><!--[--><li><a aria-current="page" href="/chatgpt-ui/zh/guide/configuration.html#数据库" class="router-link-active router-link-exact-active sidebar-item" aria-label="数据库"><!--[--><!--]--> 数据库 <!--[--><!--]--></a><!----></li><li><a aria-current="page" href="/chatgpt-ui/zh/guide/configuration.html#邮箱验证" class="router-link-active router-link-exact-active sidebar-item" aria-label="邮箱验证"><!--[--><!--]--> 邮箱验证 <!--[--><!--]--></a><!----></li><li><a aria-current="page" href="/chatgpt-ui/zh/guide/configuration.html#api-代理" class="router-link-active router-link-exact-active sidebar-item" aria-label="API 代理"><!--[--><!--]--> API 代理 <!--[--><!--]--></a><!----></li><li><a aria-current="page" href="/chatgpt-ui/zh/guide/configuration.html#后端-csrf-白名单" class="router-link-active router-link-exact-active sidebar-item" aria-label="后端 CSRF 白名单"><!--[--><!--]--> 后端 CSRF 白名单 <!--[--><!--]--></a><!----></li><li><a aria-current="page" href="/chatgpt-ui/zh/guide/configuration.html#客户端配置" class="router-link-active router-link-exact-active sidebar-item" aria-label="客户端配置"><!--[--><!--]--> 客户端配置 <!--[--><!--]--></a><!----></li><li><a aria-current="page" href="/chatgpt-ui/zh/guide/configuration.html#用户注册控制" class="router-link-active router-link-exact-active sidebar-item" aria-label="用户注册控制"><!--[--><!--]--> 用户注册控制 <!--[--><!--]--></a><!----></li><li><a aria-current="page" href="/chatgpt-ui/zh/guide/configuration.html#网页搜索功能控制" class="router-link-active router-link-exact-active sidebar-item" aria-label="网页搜索功能控制"><!--[--><!--]--> 网页搜索功能控制 <!--[--><!--]--></a><!----></li><li><a aria-current="page" href="/chatgpt-ui/zh/guide/configuration.html#节俭模式控制" class="router-link-active router-link-exact-active sidebar-item" aria-label="节俭模式控制"><!--[--><!--]--> 节俭模式控制 <!--[--><!--]--></a><!----></li><!--]--></ul></li><li><a href="/chatgpt-ui/zh/guide/problems.html" class="sidebar-item" aria-label="遇到问题"><!--[--><!--]--> 遇到问题 <!--[--><!--]--></a><!----></li><li><a href="/chatgpt-ui/zh/guide/development.html" class="sidebar-item" aria-label="开发指南"><!--[--><!--]--> 开发指南 <!--[--><!--]--></a><!----></li><li><a href="/chatgpt-ui/zh/guide/buymeacoffee.html" class="sidebar-item" aria-label="续杯咖啡"><!--[--><!--]--> 续杯咖啡 <!--[--><!--]--></a><!----></li><!--]--></ul></li><!--]--></ul><!--[--><!--]--></aside><!--]--><!--[--><main class="page"><!--[--><!--]--><div class="theme-default-content"><!--[--><!--]--><div><h1 id="配置参考" tabindex="-1"><a class="header-anchor" href="#配置参考" aria-hidden="true">#</a> 配置参考</h1><h2 id="数据库" tabindex="-1"><a class="header-anchor" href="#数据库" aria-hidden="true">#</a> 数据库</h2><p>后端默认使用内置的 Sqlite 来存储数据,如果不连接外部数据库,数据将在容器销毁后丢失。</p><p><code>chatgpt-ui-wsgi-server</code> 镜像提供环境变量 <code>DB_URL</code> 来配置与外部数据库的连接,以下是 <code>DB_URL</code> 的链接格式对照表。</p><table><thead><tr><th>数据库</th><th>链接</th></tr></thead><tbody><tr><td>PostgreSQL</td><td>postgres://USER:PASSWORD@HOST:PORT/DATABASE_NAME</td></tr><tr><td>MySQL</td><td>mysql://USER:PASSWORD@HOST:PORT/DATABASE_NAME</td></tr><tr><td>SQLite</td><td>sqlite:///PATH</td></tr></tbody></table><p>例如我使用 PostgreSQL则配置如下</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>backend-wsgi-server:
image: wongsaang/chatgpt-ui-wsgi-server:latest
environment:
- DB_URL=postgres://postgres:postgrespw@localhost:49153/chatgpt
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="邮箱验证" tabindex="-1"><a class="header-anchor" href="#邮箱验证" aria-hidden="true">#</a> 邮箱验证</h2><p>如果你开放用户注册功能,并需要向用户发送邮箱激活链接,需要在 <code>wsgi-server</code> 服务中配置以下环境变量:</p><table><thead><tr><th>参数</th><th>说明</th><th>默认值</th></tr></thead><tbody><tr><td>ACCOUNT_EMAIL_VERIFICATION</td><td>邮箱验证方式,可选值: none, optional, mandatory</td><td>optional</td></tr><tr><td>EMAIL_HOST</td><td>SMTP 服务器地址</td><td>smtp.mailgun.org</td></tr><tr><td>EMAIL_PORT</td><td>SMTP 服务器端口号</td><td>587</td></tr><tr><td>EMAIL_HOST_USER</td><td>用户名</td><td>-</td></tr><tr><td>EMAIL_HOST_PASSWORD</td><td>密码</td><td>-</td></tr><tr><td>EMAIL_USE_TLS</td><td>是否加密</td><td>True</td></tr><tr><td>EMAIL_FROM</td><td>发件邮箱</td><td>webmaster@localhost</td></tr></tbody></table><h2 id="api-代理" tabindex="-1"><a class="header-anchor" href="#api-代理" aria-hidden="true">#</a> API 代理</h2><p>如果您的网络无法请求 OpenAI 的 API 地址,您可以在 <code>wsgi-server</code> 服务中配置代理,如何搭建代理服务,需要您自行搜索。</p><p>例如:</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>backend-wsgi-server:
image: wongsaang/chatgpt-ui-wsgi-server:latest
environment:
- OPENAI_API_PROXY=https://openai.proxy.com/v1 # 注意,域名后面需要带上 v1
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="后端-csrf-白名单" tabindex="-1"><a class="header-anchor" href="#后端-csrf-白名单" aria-hidden="true">#</a> 后端 CSRF 白名单</h2><p>如果你在访问管理后台的时候遇到 <code>CSRF verification failed</code>,可能你的 <code>APP_DOMAIN</code> 没有配置对。在 <code>wsgi-server</code> 服务下有个环境变量 <code>wsgi-server</code>。 它的值应该是 <code>backend-web-server</code> 的地址+端口, 默认: <code>localhost:9000</code></p><p>假如我把 <code>chagpt.com</code> 这个域名解析到了服务器,并且我的 <code>backend-web-server</code> 服务绑定了 9000 这个端口。正确的配置如下:</p><div class="language-text line-numbers-mode" data-ext="text"><pre class="language-text"><code>backend-wsgi-server:
image: wongsaang/chatgpt-ui-wsgi-server:latest
environment:
- APP_DOMAIN=chagpt.com:9000
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h2 id="客户端配置" tabindex="-1"><a class="header-anchor" href="#客户端配置" aria-hidden="true">#</a> 客户端配置</h2><table><thead><tr><th>参数</th><th>说明</th><th>默认值</th></tr></thead><tbody><tr><td>SERVER_DOMAIN</td><td>服务端地址</td><td>http://backend-web-server</td></tr><tr><td>DEFAULT_LOCALE</td><td>默认语言</td><td>en</td></tr><tr><td>NUXT_PUBLIC_APP_NAME</td><td>应用名称</td><td>ChatGPT UI</td></tr><tr><td>NUXT_PUBLIC_TYPEWRITER</td><td>是否开启 打字机 效果[true/false]</td><td>true</td></tr><tr><td>NUXT_PUBLIC_TYPEWRITER_DELAY</td><td>打字机效果的延迟时间,单位:毫秒</td><td>50</td></tr></tbody></table><h2 id="用户注册控制" tabindex="-1"><a class="header-anchor" href="#用户注册控制" aria-hidden="true">#</a> 用户注册控制</h2><p>部署完整后,在管理后台的 <code>Chat-&gt;Setting</code> 下面有 <code>open_registration</code> 设置项,用于控制是否开放用户注册。默认是 <code>True</code> (允许用户注册),如果不需要,请改成 <code>False</code></p><h2 id="网页搜索功能控制" tabindex="-1"><a class="header-anchor" href="#网页搜索功能控制" aria-hidden="true">#</a> 网页搜索功能控制</h2><p>该功能默认处于关闭状态,你可以在管理后台的 <code>Chat-&gt;Settings</code> 中开启它,在 Settings 中有一个 <code>open_web_search</code> 的设置项,把它的值设置为 <code>True</code></p><h2 id="节俭模式控制" tabindex="-1"><a class="header-anchor" href="#节俭模式控制" aria-hidden="true">#</a> 节俭模式控制</h2><p>该功能默认处于开启状态,你可以在管理后台的 <code>Chat-&gt;Settings</code> 中关闭它,在 Settings 中有一个 <code>open_frugal_mode_control</code> 的设置项,把它的值设置为 <code>False</code></p></div><!--[--><!--]--></div><footer class="page-meta"><!----><div class="meta-item last-updated"><span class="meta-item-label">Last Updated: </span><!----></div><div class="meta-item contributors"><span class="meta-item-label">Contributors: </span><span class="meta-item-info"><!--[--><!--[--><span class="contributor" title="email: rafiwx@gmail.com">Rafi</span><!--[-->, <!--]--><!--]--><!--[--><span class="contributor" title="email: iluozan@126.com">AI&amp;I</span><!----><!--]--><!--]--></span></div></footer><nav class="page-nav"><p class="inner"><span class="prev"><a href="/chatgpt-ui/zh/guide/quick-start.html" class="" aria-label="快速开始"><!--[--><!--]--> 快速开始 <!--[--><!--]--></a></span><span class="next"><a href="/chatgpt-ui/zh/guide/problems.html" class="" aria-label="遇到问题"><!--[--><!--]--> 遇到问题 <!--[--><!--]--></a></span></p></nav><!--[--><!--]--></main><!--]--></div><!----><!--]--></div>
<script type="module" src="/chatgpt-ui/assets/app-525ee8ad.js" defer></script>
</body>
</html>