Skip to content

Latest commit

 

History

History
184 lines (128 loc) · 8.7 KB

README.md

File metadata and controls

184 lines (128 loc) · 8.7 KB
Raw

chatgpt-web

Pure Javascript ChatGPT demo based on OpenAI API

纯JS实现的ChatGPT项目，基于OpenAI API

部署一个HTML文件即可使用。

支持复制/更新/刷新会话，语音输入，朗读等功能，以及众多自定义选项。

支持搜索会话，深色模式，自定义头像，快捷键，多语言，环境变量，PWA应用，API额度显示等。

支持加密HTML文件。

参考项目: markdown-it, highlight.js, github-markdown-css, chatgpt-html, markdown-it-copy, markdown-it-texmath, awesome-chatgpt-prompts-zh

示例

Demo

在线预览 （使用需配置OpenAI接口和API密钥）

使用方法

注意：部署反代接口请注意OpenAI的支持地区，部署在不支持地区的服务器可能导致封号！最好配置https，公网以http方式明文传输API key非常不安全！

  • 仅部署HTML

    使用任意http server部署index.html。打开网页设置，填写API密钥，填写OpenAI接口，当本地

    • 可正常访问api.openai.com，填写https://api.openai.com/

    • 不可正常访问api.openai.com，填写其反代地址（可使用Cloudflare Worker等反代），注意：反代接口响应需添加跨域Header Access-Control-Allow-Origin

    • OpenAI接口也可以在环境变量中单独配置。

  • 同时部署HTML和OpenAI反代接口

    注意：服务器需正常访问api.openai.com，不用设置OpenAI接口了

    • 使用nginx，示例配置如下

      map $http_authorization $gptauth {
    default $http_authorization;
    #配置默认API密钥，在Bearer 后填写。如只允许在网页端设置API密钥使用，请删除下一行。
    ""      "Bearer sk-your-token";
}
server {
    listen      80;
    server_name example.com;
    #开启openai接口的gzip压缩，大量重复文本的压缩率高，节省服务端流量
    gzip on;
    gzip_min_length 1k;
    gzip_types text/event-stream;

    #如需部署在网站子路径，如"example.com/chatgpt"，配置如下
    #location ^~ /chatgpt/v1 {
    location ^~ /v1 {
        proxy_pass https://api.openai.com/v1;
        proxy_set_header Host api.openai.com;
        proxy_ssl_name api.openai.com;
        proxy_ssl_server_name on;
        proxy_set_header Authorization $gptauth;
        proxy_pass_header Authorization;
        #流式传输，不关闭buffering缓存会卡死，必须配置！！！
        proxy_buffering off;
    }
    #与上面反代接口的路径保持一致
    #location /chatgpt {
    location / {
        alias /usr/share/nginx/html/;
        index index.html;
    }
}

      如服务器无法正常访问api.openai.com，可配合socat反代和http代理使用，proxy_pass配置改成

      proxy_pass https://127.0.0.1:8443/v1;

      并打开socat

      socat TCP4-LISTEN:8443,reuseaddr,fork PROXY:http代理地址:api.openai.com:443,proxyport=http代理端口

    • 使用Caddy，可以自动生产HTTPS证书，示例配置如下

      yourdomain.example.com {
    reverse_proxy /v1/* https://api.openai.com {
        header_up Host api.openai.com
        header_up Authorization "{http.request.header.Authorization}"
        header_up Authorization "Bearer sk-your-token"
    }

    file_server / {
        root /var/wwwroot/chatgpt-web
        index index.html
    }
}

      Caddy 2.6.5及之后版本支持https_proxy和http_proxy环境变量，如服务器无法正常访问api.openai.com，可先设置代理环境变量

环境变量

OpenAI接口和密钥可以单独在环境变量文件中配置。

新建环境变量文件env.js到index.html同目录下，示例如下。

envAPIEndpoint="https://api.openai.com/"
envAPIKey="sk-your-token"

PWA应用

部署文件icon.png，manifest.json，sw.js到index.html同目录下，即可支持PWA应用。

注意：如果重命名index.html使用，则sw.js文件中./index.html也需修改。

部署PWA应用后，更新html文件需同步更新sw.js，不然无法更新成功。

自定义选项

  • 左边栏支持，搜索会话，新建/重命名/删除(会话/文件夹)，中英双语，浅色/深色/自动主题模式，导出/导入/重置会话和设置数据，快捷键，显示API额度，显示本地存储。

  • 可选GPT模型，默认gpt-3.5，当前使用gpt-4模型需通过OpenAI的表单申请，或使用ChatGPT-to-API模拟网页ChatGPT为API使用（使用gpt-4需Plus账户）。

  • 可选OpenAI接口地址，使用nginx或caddy部署反代后可以不设置。

  • 可选API密钥，默认不设置，如需网页设置自定义API密钥使用，反代接口最好配置https，公网以http方式明文传输API key极易被中间人截获。

  • 可选用户头像，可修改为任意图片地址。

  • 可选系统角色，默认不开启，有四个预设角色，并动态加载awesome-chatgpt-prompts-zh或awesome-chatgpt-prompts中的角色。

  • 可选角色性格，默认灵活创新，对应接口文档的top_p参数。

  • 可选回答质量，默认平衡，对应接口文档的temperature参数。

  • 修改打字机速度，默认较快，值越大速度越快。

  • 可选连续会话上下文信息限制，默认25条，对话中包含上下文信息，会导致api费用增加。设置为0条则关闭连续会话。

  • 允许长回复，默认关闭，开启后可能导致api费用增加，并丢失全部上下文，对于一些要发送继续才完整的回复，不用发继续了。

  • 选择语音，默认Bing语音，支持Azure语音和系统语音，可分开设置提问语音和回答语音。

  • 音量，默认最大。

  • 语速，默认正常。

  • 音调，默认正常。

  • 允许连续朗读，默认开启，连续郎读到所有对话结束。

  • 允许自动朗读，默认关闭，自动朗读新的回答。iOS需打开设置-自动播放视频预览，Mac上Safari需打开此网站的设置-允许全部自动播放

  • 支持语音输入，默认识别为普通话，可长按语音按钮修改识别语言选项。语音识别必需条件：使用chrome内核系浏览器 + https网页或本地网页，允许网页的麦克风权限，并已安装麦克风设备。

  • 自动发送关键词，默认为空，识别到关键词后自动发送。

  • 自动停止关键词，默认为空，识别到关键词后自动停止识别。

  • 自动发送延迟时间，默认为0秒，即不自动发送。不为0秒时，表示识别到内容后，自动发送延迟的时间。

  • 保持监听，默认关闭，保持麦克风一直处于监听状态，除非识别报错或手动关闭识别。

加密HTML文件

使用加密网页可加密index.html文件。

  • 密码，打开加密HTML的密码。

  • 是否压缩，默认允许，较大HTML可减少加密后文件体积。

  • 允许记住密码，默认允许，是否允许前端记住密码。

  • 记住密码有效期，默认永不过期，过期后需重新输入密码。

  • 拷贝index.html内容到要加密的HTML文本框，点击生成按钮后，即可下载加密HTML，并替换index.html使用。

注意：该方式仅加密前端HTML，不加密OpenAI反代接口。

可取消OpenAI反代接口的默认API密钥，打开index.html代码，此行结尾添加代码value="sk-xxx"，则默认使用该密钥