feat:README (#4118)

Co-authored-by: yuehuazhang <yuehuazhang@tencent.com>
This commit is contained in:
yuehua-s 2024-06-01 11:30:32 +08:00 committed by GitHub
parent 70f4444458
commit 67ed340c3b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -1,4 +1,3 @@
### 开始使用 ### 开始使用
> 环境配置完成后启动步骤为先启动chatchat-server然后启动chatchat-frontend。 > 环境配置完成后启动步骤为先启动chatchat-server然后启动chatchat-frontend。
@ -30,36 +29,21 @@ vim model_providers.yaml
> >
> 详细配置请参考[README.md](../model-providers/README.md) > 详细配置请参考[README.md](../model-providers/README.md)
- 启动服务 - 启动服务
```shell ```shell
chatchat -a chatchat -a
``` ```
#### 源码启动chatchat-server #### 源码启动chatchat-server
- 安装chatchat - 安装chatchat
```shell ```shell
git clone https://github.com/chatchat-space/Langchain-Chatchat.git git clone https://github.com/chatchat-space/Langchain-Chatchat.git
``` ```
- 复制配置文件 - 修改`model_providers.yaml`文件,即可完成自定义平台加载
> 后面我们会提供一个一键初始化的脚本,现在您可以手动复制配置文件
> 请注意:这个命令会清空数据库,如果您有重要数据,请备份
```shell ```shell
cd Langchain-Chatchat/libs/chatchat-server/chatchat cd Langchain-Chatchat/libs/chatchat-server/chatchat/configs
mkdir -p ~/.config/chatchat/
cp -r configs ~/.config/chatchat/
cp -r data ~/.config/chatchat/
cp -r img ~/.config/chatchat/
```
> 当配置文件复制完成后,配置拷贝后路径的`model_providers.yaml`文件,即可完成自定义平台加载
```shell
cd ~/.config/chatchat
vim model_providers.yaml vim model_providers.yaml
``` ```
>
> 注意: 在您配置平台之前请确认平台依赖完整例如智谱平台您需要安装智谱sdk `pip install zhipuai` > 注意: 在您配置平台之前请确认平台依赖完整例如智谱平台您需要安装智谱sdk `pip install zhipuai`
> >
> 详细配置请参考[README.md](../model-providers/README.md) > 详细配置请参考[README.md](../model-providers/README.md)
@ -67,10 +51,10 @@ vim model_providers.yaml
- 初始化仓库 - 初始化仓库
> 请注意:这个命令会清空数据库,如果您有重要数据,请备份 > 请注意:这个命令会清空数据库,如果您有重要数据,请备份
```shell ```shell
cd chatchat-server/chatchat cd ..
python init_database.py python init_database.py --recreate-vs
``` ```
- 启动服务 - 启动服务
```shell ```shell
python startup.py -a python startup.py -a
``` ```