Skip to content

Commit 609c183

Browse files
committed
docs(1panel): 更新部署脚本和文档中的API代理配置
修正部署脚本和文档中的nginx代理配置,确保路径正确转发 添加重要说明和使用建议,完善1Panel集成文档内容
1 parent 0303f6b commit 609c183

File tree

2 files changed

+41
-5
lines changed

2 files changed

+41
-5
lines changed

1PANEL-INTEGRATION.md

Lines changed: 34 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@
1212
- 文件管理和数据库管理
1313
- 丰富的应用商店
1414

15+
## 1Panel 使用说明
16+
17+
根据 [1Panel 官方文档](https://docs.1panel.pro/quick_start/),1Panel 是一个现代化的 Linux 服务器运维管理面板,主要通过 **容器编排****网站管理** 两个核心功能来管理应用。
18+
19+
### 核心概念
20+
21+
1. **容器编排**:使用 Docker Compose 管理容器化应用的生命周期
22+
2. **网站管理**:基于 OpenResty 的反向代理和 SSL 证书管理
23+
3. **应用商店**:一键部署常用开源软件
24+
1525
## 部署方案
1626

1727
本项目提供两种 1Panel 部署方式:
@@ -25,6 +35,7 @@
2535
- 可视化的日志查看和监控
2636
- 统一的环境变量管理
2737
- 容易维护和更新
38+
- 符合 1Panel 官方推荐的使用方式
2839

2940
### 方案二:网站反向代理
3041

@@ -33,7 +44,8 @@
3344
**优势:**
3445
- 自动 SSL 证书管理
3546
- 更好的域名管理
36-
- 内置的 Web 服务器优化
47+
- 内置的 Web 服务器优化(基于 OpenResty)
48+
- 支持高级 Nginx 配置
3749

3850
## 快速部署
3951

@@ -94,6 +106,11 @@ cd Blog
94106

95107
### 方案二:网站反向代理部署
96108

109+
**前提条件**
110+
- 已完成方案一的容器编排部署
111+
- 容器服务正常运行
112+
- 域名已正确解析到服务器 IP
113+
97114
#### 1. 先启动容器
98115

99116
按照上面的方案一先启动容器服务。
@@ -113,8 +130,8 @@ cd Blog
113130
在网站的 **配置** -> **修改配置** 中添加:
114131

115132
```nginx
116-
location /api {
117-
proxy_pass http://127.0.0.1:8080;
133+
location /api/ {
134+
proxy_pass http://127.0.0.1:8080/api/;
118135
proxy_set_header Host $host;
119136
proxy_set_header X-Real-IP $remote_addr;
120137
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -125,6 +142,11 @@ location /api {
125142
}
126143
```
127144

145+
**重要说明**
146+
- 使用 `location /api/``proxy_pass http://127.0.0.1:8080/api/` 确保路径正确转发
147+
- 后端服务所有API都在 `/api` 路径下,因此需要保持路径一致
148+
- 尾部的 `/` 很重要,确保路径正确匹配和转发
149+
128150
#### 4. 配置 SSL 证书(推荐)
129151

130152
1. 在网站管理中找到您的网站
@@ -242,25 +264,34 @@ FRONTEND_PORT=4321
242264

243265
## 最佳实践
244266

267+
### 1Panel 使用建议
268+
269+
1. **优先使用容器编排**:1Panel 的容器编排功能是管理 Docker 应用的推荐方式
270+
2. **合理使用网站管理**:主要用于域名绑定、SSL 证书管理和反向代理配置
271+
3. **遵循官方文档**:参考 [1Panel 官方文档](https://docs.1panel.pro/) 获取最新的使用指南
272+
245273
### 安全建议
246274

247275
1. **定期备份**: 设置定时任务备份数据库
248276
2. **更新密码**: 定期更换数据库和 JWT 密码
249277
3. **监控日志**: 在 1Panel 中设置日志监控告警
250278
4. **SSL 证书**: 使用 1Panel 的自动续期功能
279+
5. **防火墙配置**: 确保只开放必要的端口(80, 443, 1Panel 管理端口)
251280

252281
### 性能优化
253282

254283
1. **资源限制**: 根据服务器配置调整 Docker Compose 中的资源限制
255284
2. **日志管理**: 在 1Panel 中配置日志轮转
256285
3. **缓存配置**: 在 OpenResty 中配置静态文件缓存
286+
4. **数据库优化**: 根据实际使用情况调整 PostgreSQL 配置
257287

258288
### 维护流程
259289

260290
1. **监控**: 使用 1Panel 的仪表盘监控系统状态
261291
2. **备份**: 每日自动备份数据库
262292
3. **更新**: 在低峰期进行代码更新
263293
4. **清理**: 定期清理未使用的 Docker 资源
294+
5. **日志检查**: 定期检查应用和系统日志
264295

265296
---
266297

deploy-1panel.sh

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -140,8 +140,8 @@ show_1panel_deployment_guide() {
140140
log_info "如果需要单独代理API,可在网站配置中添加:"
141141
log_info ""
142142
cat << 'EOF'
143-
location /api {
144-
proxy_pass http://127.0.0.1:8080;
143+
location /api/ {
144+
proxy_pass http://127.0.0.1:8080/api/;
145145
proxy_set_header Host $host;
146146
proxy_set_header X-Real-IP $remote_addr;
147147
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
@@ -151,6 +151,11 @@ show_1panel_deployment_guide() {
151151
proxy_read_timeout 60s;
152152
}
153153
EOF
154+
log_info ""
155+
log_info "重要说明:"
156+
log_info "- 使用 location /api/ 和 proxy_pass http://127.0.0.1:8080/api/"
157+
log_info "- 后端所有API都在 /api 路径下,需要保持路径一致"
158+
log_info "- 尾部的 / 很重要,确保路径正确匹配"
154159
log_info ""
155160
log_info "=== 部署完成后 ==="
156161
log_info "1. 前端访问:http://$domain 或 https://$domain"

0 commit comments

Comments
 (0)