Skip to content

Commit d5e1404

Browse files
committed
docs:添加常见问题和挑战实践教程
1 parent 3dfb43a commit d5e1404

10 files changed

+159
-5
lines changed

docs/faq/install_configuration.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# 安装部署以及启动问题
2+
3+
## 1 安装 MaxKB 过程报错 docker-compose--X.XX.X 无法启动或者访问服务
4+
5+
!!! Abstract ""
6+
Docker 版本太老可能会导致安装失败,建议环境建议使用安装包内的 Docker。安装包所使用的 Docker 版本为 27.2.0、Compose 版本为 v2.29.2。
7+
8+
9+
## 2 离线部署提示 failed to cast to expected type: strconv.ParseInt: parsing "2G"
10+
11+
!!! Abstract ""
12+
在配置文件中内存设置格式存在问题。打开配置文件 docker-compose-pgsql.yml,找到 services.pgsql.mem_limit 的设置项。 将内存设置值从 "2G" 修改为小写的 "2g",执行 mkctl reload 命令重新加载配置。
13+
14+
## 3 升级过程提示 ModuleNotFoundError: No module named 'XXX'
15+
16+
!!! Abstract ""
17+
某些旧版本的依赖包与新版本不兼容,导致系统无法正常运行。进入依赖包的存储目录:
18+
执行以下命令,创建模型:
19+
```
20+
cd /opt/maxkb/python-packages
21+
```
22+
找到导致依赖冲突的包,通常通过查看错误日志来确定具体冲突的包名。完成依赖包的清理后,重启服务 mkctl restart 以确保更改生效。
23+
24+
## 4 PostgreSQL 超过最大客户端连接数,提示 too many clients already 的错误
25+
26+
!!! Abstract ""
27+
这表明当前配置的客户端连接数已达到上限,需要调整配置以允许更多的连接。进入 PostgreSQL 配置文件所在的目录:
28+
```
29+
cd /opt/maxkb/data
30+
```
31+
找到 postgresql.conf 文件中找到 max_connections 参数,将其值设置为所需的连接数。例如,将最大连接数设置为 200
32+
```
33+
max_connections = 200
34+
```
35+
停止当前运行的 MaxKB 服务,删除 PostgreSQL 容器,:
36+
```
37+
docker stop maxkb
38+
39+
docker rm maxkb
40+
```
41+
执行 mkctl reload 重新加载服务配置并启动服务。

docs/faq/system_management.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# 系统管理
2+
3+
## 1 用户管理
4+
5+
### 1.1 忘记了登录密码如何处理
6+
7+
!!! Abstract ""
8+
**非 admin 用户忘记密码**
9+
10+
- 已设置邮箱绑定:如果用户已设置邮箱并完成绑定,可在个人信息页面通过【修改密码】功能进行密码修改与找回。
11+
- 未设置邮箱绑定:若用户未设置邮箱绑定,可由 admin 管理人员登录系统,在【用户管理】页面中,找到对应用户并直接修改其密码,从而帮助用户找回密码。
12+
13+
!!! Abstract ""
14+
**admin 用户忘记密码**
15+
如果已配置邮箱设置,可在登录页面点击【忘记密码】进行密码找回。若未配置邮箱,则需通过修改数据库将密码恢复为默认密码。操作步骤如下:
16+
在线安装进入 MaxKB 容器(若是离线安装包,请进入 pgsql 容器)
17+
18+
```
19+
docker exec -it maxkb bash
20+
```
21+
22+
登录 PgSQL
23+
```
24+
psql -Uroot
25+
```
26+
进入 maxkb数据库
27+
```
28+
\c maxkb;
29+
```
30+
连接到数据库后,执行下面的 SQL 语句可以将用户 admin 的密码重置为 MaxKB@123..
31+
```
32+
update "public"."user" set password='d880e722c47a34d8e9fce789fc62389d' where username='admin';
33+
```
34+
35+
**注意:找回 admin 密码后优先配置邮箱设置,以便下次忘记密码时能直接使用【忘记密码】功能进行找回。**
36+
37+
38+
39+
40+
### 1.2 编辑用户时没有权限访问
41+
42+
!!! Abstract ""
43+
网关配置中未对 PUT 方法进行放行,从而导致权限验证失败。
44+
45+
![doc](../img/FAQ/报错没有权限.png){width="900px"}
46+
47+
48+
## 2 模型对接
49+
50+
### 2.1 对接 Ollama 时提示 API 域名无效
51+
52+
![doc](../img/FAQ/API域名无效.png)
53+
54+
!!! Abstract ""
55+
**API 域名内容说明**
56+
57+
- MaxKB 版本为 0.9.0,API 域名格式为:http://您ollama 所在服务的ip地址:您 ollama 的端口号 /v1 。
58+
- MaxKB 版本为 0.9.1及之后的版本 API 域名格式:http://您ollama 所在服务的ip地址:您 ollama 的端口号 / 。
59+
60+
**注意:API 域名不可使用 127.0.0.1 或 localhost。**
61+
62+
!!! Abstract ""
63+
**获取 Ollama 服务的 IP 地址**
64+
在 Ollama 所在服务器上执行: ip addr , 获取到服务器的 IP 地址。 查询 Ollama 服务器 IP 地址为 172.26.186.35,则 API 域名为:http://172.26.186.53:11434
65+
66+
![doc](../img/FAQ/获取ipaddr.png){width="900px"}
67+
68+
!!! Abstract ""
69+
**确保服务可访问:**
70+
MaxKB 容器需要可正常访问 Ollama 服务。在 maxkb 容器中访问 Ollama 的 API 域名,确保返回 【Ollama is running 】的状态。
71+
72+
![doc](../img/FAQ/ollama可访问.png){width="900px"}
73+
74+
!!! Abstract ""
75+
**Ollama 配置文件修改:**
76+
修改 /etc/systemd/system/ollama 文件,配置监听在 0.0.0.0 网段 增加 Environment=“OLLAMA_HOST=0.0.0.0” 。
77+
78+
!!! Abstract ""
79+
**以上确认无误后,再到 MaxKB 中 添加 Ollama 的模型。
80+
对于 Window 环境安装 Ollama 可进一步参考:[Windows 系统本地部署 Ollama +MaxKB 安装教程](https://kb.fit2cloud.com/?p=349d848b-7a0a-421b-8029-38e0440f35d4)**
81+
82+
83+
84+
### 2.2 对接图片生成模型时验证失败
85+
![doc](../img/FAQ/图片生成模型验证失败.png){width="900px"}
86+
87+
!!! Abstract ""
88+
原因是参数组件类型错误。具体表现为“guidance_scale”组件类型设置错误。解决方法是将“guidance_scale”组件类型更改为滑块,并将步长设置为 1。
89+
90+
![doc](../img/FAQ/设置步长为1.png){width="900px"}
91+
92+
### 2.3 对接 XInference 语音合成模型验证失败
93+
![doc](../img/FAQ/对接XInferenc语音模型失败.png)
94+
95+
!!! Abstract ""
96+
错误信息如下: Error code: 400 - {'detail': '[address=0.0.0.0:4215, pid=41292] Model not found, uid: XXX'} 。
97+
原因可能是模型名称或版本不正确。 解决步骤:
98+
99+
- 检查模型名称:在容器中通过 curl 请求查看是否有对应的模型名称返回
100+
- 检查 XInference 版本。当前使用的版本为 v1.3.0.post2,这是一个测试版本,可能存在不稳定的情况。建议切换到更稳定的版本,例如 XInference 的最新稳定版本。
101+
102+
103+
### 2.4 检查参数是否正确:Connection error
104+
105+
!!! Abstract ""
106+
这通常是由网络连接问题引起的。排查思路:
107+
108+
- 检查防火墙设置:确认防火墙是否限制了相关端口。如果限制了,请开放该端口,确保容器可以正常访问网络。
109+
110+
- 检查容器网络配置:确认容器内是否有网络连接。可以尝试在容器内执行网络测试命令(如 ping 或 curl)来检查网络连通性。

docs/img/FAQ/API域名无效.png

224 KB
Loading

docs/img/FAQ/ollama可访问.png

35.4 KB
Loading
100 KB
Loading
260 KB
Loading
62.7 KB
Loading

docs/img/FAQ/获取ipaddr.png

120 KB
Loading

docs/img/FAQ/设置步长为1.png

60.7 KB
Loading

mkdocs.yml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,14 @@ nav:
103103
- 开发环境搭建: dev_manual/dev_environment.md
104104
- 通过API KEY进行对话: dev_manual/APIKey_chat.md
105105
- 常见问题:
106-
- Ollama离线部署LLM模型: faq/Offline_install_OllamaModel.md
107-
- Ollama使用GPU运行LLM模型: faq/GPU_runOllama.md
108-
- 将MaxKB小助手集成到Halo中: faq/maxkb_In_halo.md
109-
- MaxKB和Dify有什么区别: faq/MaxKB VS.Dify.md
110-
- 知识库文档如何合理分段: faq/doc_segment.md
106+
- 安装部署: faq/install_configuration.md
107+
- 系统管理: faq/system_management.md
108+
- 实践教程:
109+
- Ollama 离线部署 LLM 模型: faq/Offline_install_OllamaModel.md
110+
- Ollama 使用 GPU 运行 LLM 模型: faq/GPU_runOllama.md
111+
- 将 MaxKB 小助手集成到 Halo 中: faq/maxkb_In_halo.md
112+
- MaxKB 和 Dify 有什么区别: faq/MaxKB VS.Dify.md
113+
- 知识库文档如何合理分段: faq/doc_segment.md
111114
- 联系我们: contact.md
112115

113116
markdown_extensions:

0 commit comments

Comments
 (0)