川虎 ChatGPT 🐯 Chuanhu ChatGPT

为ChatGPT API提供了一个轻快好用的Web图形界面

实时回复 / 无限对话 / 保存对话记录 / 预设Prompt集 / 联网搜索 / 根据文件回答
渲染LaTex / 渲染表格 / 渲染代码 / 代码高亮 / 自定义api-URL / “小而美”的体验 / Ready for GPT-4

Animation Demo

## 目录 |[使用技巧](#使用技巧)|[安装方式](#安装方式)|[疑难杂症解决](#疑难杂症解决)| [给作者买可乐🥤](#捐款) | | ---- | ---- | ---- | --- | ## 使用技巧 - 使用System Prompt可以很有效地设定前提条件。 - 使用Prompt模板功能时，选择Prompt模板集合文件，然后从下拉菜单中选择想要的prompt。 - 如果回答不满意，可以使用`重新生成`按钮再试一次 - 对于长对话，可以使用`优化Tokens`按钮减少Tokens占用。 - 输入框支持换行，按`shift enter`即可。 - 部署到服务器：将程序最后一句改成`demo.launch(server_name="0.0.0.0", server_port=<你的端口号>)`。 - 获取公共链接：将程序最后一句改成`demo.launch(share=True)`。注意程序必须在运行，才能通过公共链接访问。 - 在Hugging Face上使用：建议在右上角 **复制Space** 再使用，这样 ## 安装方式 ### 直接在Hugging Face上部署访问[本项目的Hugging Face页面](https://huggingface.co/spaces/JohnSmith9982/ChuanhuChatGPT)，点击右上角的 **复制Space** ，新建一个私人空间。然后就直接可以开始使用啦！放心，这是免费的。注意不要直接使用我的Space，否则排队速度会很漫长。在你的私人空间里使用能大大减少排队时间，App反应也会更加迅速。

Hugging Face的优点：部署容易，甚至不需要电脑。免费。无需配置代理。 Hugging Face的缺点：支持的gradio版本比较老旧，不支持最新的界面。 ### 本地部署 1. **下载本项目** ```shell git clone https://github.com/GaiZhenbiao/ChuanhuChatGPT.git cd ChuanhuChatGPT ``` 或者，点击网页右上角的 `Download ZIP`，下载并解压完成后进入文件夹，进入`终端`或`命令提示符`。如果你使用Windows，应该在文件夹里按住`shift`右键，选择“在终端中打开”。如果没有这个选项，选择“在此处打开Powershell窗口”。如果你使用macOS，可以在Finder底部的路径栏中右键当前文件夹，选择`服务-新建位于文件夹位置的终端标签页`。 downloadZIP

2. **填写API密钥** 以下3种方法任选其一：

1. 在图形界面中填写你的API密钥

这样设置的密钥会在页面刷新后被清除。

2. 在直接代码中填入你的 OpenAI API 密钥

这样设置的密钥会成为默认密钥。在这里还可以选择是否在UI中隐藏密钥输入框。

3. 在文件中设定默认密钥、用户名密码

这样设置的密钥可以在拉取项目更新之后保留。在项目文件夹中新建这两个文件：`api_key.txt` 和 `auth.json`。在`api_key.txt`中填写你的API-Key，注意不要填写任何无关内容。在`auth.json`中填写你的用户名和密码。 ``` { "username": "用户名", "password": "密码" } ```

3. **安装依赖** 在终端中输入下面的命令，然后回车。 ```shell pip install -r requirements.txt ``` 如果报错，试试 ```shell pip3 install -r requirements.txt ``` 如果还是不行，请先[安装Python](https://www.runoob.com/python/python-install.html)。如果下载慢，建议[配置清华源](https://mirrors.tuna.tsinghua.edu.cn/help/pypi/)，或者科学上网。 4. **启动** 请使用下面的命令。 ```shell python ChuanhuChatbot.py ``` 如果报错，试试 ```shell python3 ChuanhuChatbot.py ``` 如果还是不行，请先[安装Python](https://www.runoob.com/python/python-install.html)。
如果一切顺利，现在，你应该已经可以在浏览器地址栏中输入 [`http://localhost:7860`](http://localhost:7860) 查看并使用 ChuanhuChatGPT 了。 **如果你在安装过程中碰到了问题，请先查看[疑难杂症解决](#疑难杂症解决)部分。** ### 使用Docker运行

如果觉得以上方法比较麻烦，我们提供了Docker镜像

#### 拉取镜像 ```shell docker pull tuchuanhuhuhu/chuanhuchatgpt:latest ``` #### 运行 ```shell docker run -d --name chatgpt \ -e my_api_key="替换成API" \ -e USERNAME="替换成用户名" \ -e PASSWORD="替换成密码" \ -v ~/chatGPThistory:/app/history \ -p 7860:7860 \ tuchuanhuhuhu/chuanhuchatgpt:latest ``` 注：`USERNAME` 和 `PASSWORD` 两行可省略。若省略则不会启用认证。 #### 查看运行状态 ```shell docker logs chatgpt ``` #### 也可修改脚本后手动构建镜像 ```shell docker build -t chuanhuchatgpt:latest . ```

### 远程部署

如果需要在公网服务器部署本项目，请阅读该部分

### 部署到公网服务器将最后一句修改为 ``` demo.queue().launch(server_name="0.0.0.0", server_port=7860, share=False) # 可自定义端口 ``` ### 用账号密码保护页面将最后一句修改为 ``` demo.queue().launch(server_name="0.0.0.0", server_port=7860,auth=("在这里填写用户名", "在这里填写密码")) # 可设置用户名与密码 ``` ### 配置 Nginx 反向代理注意：配置反向代理不是必须的。如果需要使用域名，则需要配置 Nginx 反向代理。又及：目前配置认证后，Nginx 必须配置 SSL，否则会出现 [Cookie 不匹配问题](https://github.com/GaiZhenbiao/ChuanhuChatGPT/issues/89)。添加独立配置文件： ```nginx server { listen 80; server_name /域名/; # 请填入你设定的域名 access_log off; error_log off; location / { proxy_pass http://127.0.0.1:7860; # 注意端口号 proxy_redirect off; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; proxy_set_header Upgrade $http_upgrade; # Websocket配置 proxy_set_header Connection $connection_upgrade; #Websocket配置 proxy_max_temp_file_size 0; client_max_body_size 10m; client_body_buffer_size 128k; proxy_connect_timeout 90; proxy_send_timeout 90; proxy_read_timeout 90; proxy_buffer_size 4k; proxy_buffers 4 32k; proxy_busy_buffers_size 64k; proxy_temp_file_write_size 64k; } } ``` 修改`nginx.conf`配置文件（通常在`/etc/nginx/nginx.conf`），向http部分添加如下配置：（这一步是为了配置websocket连接，如之前配置过可忽略） ```nginx map $http_upgrade $connection_upgrade { default upgrade; '' close; } ``` 为了同时配置域名访问和身份认证，需要配置SSL的证书，可以参考[这篇博客](https://www.gzblog.tech/2020/12/25/how-to-config-hexo/#%E9%85%8D%E7%BD%AEHTTPS)一键配置 ### 全程使用Docker 为ChuanhuChatGPT 开启HTTPS 如果你的VPS 80端口与443端口没有被占用，则可以考虑如下的方法，只需要将你的域名提前绑定到你的VPS 的IP即可。此方法由[@iskoldt-X](https://github.com/iskoldt-X) 提供。首先，运行[nginx-proxy](https://github.com/nginx-proxy/nginx-proxy) ``` docker run --detach \ --name nginx-proxy \ --publish 80:80 \ --publish 443:443 \ --volume certs:/etc/nginx/certs \ --volume vhost:/etc/nginx/vhost.d \ --volume html:/usr/share/nginx/html \ --volume /var/run/docker.sock:/tmp/docker.sock:ro \ nginxproxy/nginx-proxy ``` 接着，运行[acme-companion](https://github.com/nginx-proxy/acme-companion)，这是用来自动申请TLS 证书的容器 ``` docker run --detach \ --name nginx-proxy-acme \ --volumes-from nginx-proxy \ --volume /var/run/docker.sock:/var/run/docker.sock:ro \ --volume acme:/etc/acme.sh \ --env "DEFAULT_EMAIL=你的邮箱（用于申请TLS 证书）" \ nginxproxy/acme-companion ``` 最后，可以运行ChuanhuChatGPT ``` docker run -d --name chatgpt \ -e my_api_key="你的API" \ -e USERNAME="替换成用户名" \ -e PASSWORD="替换成密码" \ -v ~/chatGPThistory:/app/history \ -e VIRTUAL_HOST=你的域名 \ -e VIRTUAL_PORT=7860 \ -e LETSENCRYPT_HOST=你的域名 \ tuchuanhuhuhu/chuanhuchatgpt:latest ``` 如此即可为ChuanhuChatGPT实现自动申请TLS证书并且开启HTTPS

--- ## 疑难杂症解决首先，请先尝试拉取本项目的最新更改，使用最新的代码重试。点击网页上的 `Download ZIP` 下载最新代码，或 ```shell git pull https://github.com/GaiZhenbiao/ChuanhuChatGPT.git main -f ``` 如果还有问题，可以再尝试重装 gradio: ``` pip install gradio --upgrade --force-reinstall ``` 很多时候，这样就可以解决问题。 ### 常见问题

配置代理

OpenAI不允许在不受支持的地区使用API，否则可能会导致账号被风控。下面给出代理配置示例：在Clash配置文件中，加入： ``` rule-providers: private: type: http behavior: domain url: "https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/lancidr.txt" path: ./ruleset/ads.yaml interval: 86400 rules: - RULE-SET,private,DIRECT - DOMAIN-SUFFIX,openai.com,你的代理规则 ``` 如果你使用 Surge，请在配置文件中加入： ``` [Rule] DOMAIN-SET,https://cdn.jsdelivr.net/gh/Loyalsoldier/surge-rules@release/private.txt,DIRECT DOMAIN-SUFFIX,openai.com,你的代理规则 ``` 注意，如果你本来已经有对应的字段，请将这些规则合并到已有字段中，否则代理软件会报错。

TypeError: Base.set () got an unexpected keyword argument

这是因为川虎ChatGPT紧跟Gradio发展步伐，你的Gradio版本太旧了。请升级依赖： ``` pip install -r requirements.txt --upgrade ```

No module named '_bz2'

> 部署在CentOS7.6,Python3.11.0上,最后报错ModuleNotFoundError: No module named '_bz2' 安装python前先下载 `bzip` 编译环境 ``` sudo yum install bzip2-devel ```

openai.error.APIConnectionError

> 如果有人也出现了`openai.error.APIConnectionError`提示的报错，那可能是`urllib3`的版本导致的。`urllib3`版本大于`1.25.11`，就会出现这个问题。 > > 解决方案是卸载`urllib3`然后重装至`1.25.11`版本再重新运行一遍就可以参见：[#5](https://github.com/GaiZhenbiao/ChuanhuChatGPT/issues/5) 在终端或命令提示符中卸载`urllib3` ``` pip uninstall urllib3 ``` 然后，通过使用指定版本号的`pip install`命令来安装所需的版本： ``` pip install urllib3==1.25.11 ``` 参考自： [解决OpenAI API 挂了代理还是连接不上的问题](https://zhuanlan.zhihu.com/p/611080662)

在 Python 文件里设定 API Key 之后验证失败

> 在ChuanhuChatbot.py中设置APIkey后验证出错，提示“发生了未知错误Orz” 参见：[#26](https://github.com/GaiZhenbiao/ChuanhuChatGPT/issues/26)

一直等待/SSL Error

> 更新脚本文件后，SSLError [#49](https://github.com/GaiZhenbiao/ChuanhuChatGPT/issues/49) > > 跑起来之后，输入问题好像就没反应了，也没报错 [#25](https://github.com/GaiZhenbiao/ChuanhuChatGPT/issues/25) > > ``` > requests.exceptions.SSLError: HTTPSConnectionPool(host='api.openai.com', port=443): Max retries exceeded with url: /v1/chat/completions (Caused by SSLError(SSLEOFError(8, 'EOF occurred in violation of protocol (_ssl.c:1129)'))) > ``` 请参考配置代理部分，将`openai.com`加入你使用的代理App的代理规则。注意不要将`127.0.0.1`加入代理，否则会有下一个错误。

网页提示错误 Something went wrong

> ``` > Something went wrong > Expecting value: 1ine 1 column 1 (char o) > ``` 出现这个错误的原因是`127.0.0.1`被代理了，导致网页无法和后端通信。请设置代理软件，将`127.0.0.1`加入直连（具体方法见上面“一直等待/SSL Error”部分）。

No matching distribution found for openai>=0.27.0

`openai`这个依赖已经被移除了。请尝试下载最新版脚本。

## Starchart [![Star History Chart](https://api.star-history.com/svg?repos=GaiZhenbiao/ChuanhuChatGPT&type=Date)](https://star-history.com/#GaiZhenbiao/ChuanhuChatGPT&Date) ## Contributors

## 捐款 🐯请作者喝可乐～