david_bai
1e22481a00
- Use "bash ./deploy.sh" consistently across docs - Prefer "docker compose" (Compose v2) and update examples accordingly - Public mode: recommend "--with-nginx" for same-origin gateway - Access: document Nginx (same-origin) vs direct ports; update HTTPS endpoints (lan-tls 8443, full 443) - Health checks: add same-origin /api examples - Add notes on NEXT_IMAGE_UNOPTIMIZED in Docker and same-origin behavior when --with-nginx is enabled - Fix bare-metal docs cross-links to Docker guides
567 lines
15 KiB
Markdown
567 lines
15 KiB
Markdown
# PrivyDrop Docker 一键部署（推荐）
|
||
|
||
本指南提供 PrivyDrop 的 Docker 一键部署方案，支持内网与公网，一次命令完成配置、构建、启动与证书自动化。
|
||
|
||
## 🚀 快速开始（置顶）
|
||
|
||
```bash
|
||
# 内网（无域名/无公网IP）
|
||
bash ./deploy.sh --mode lan-http
|
||
|
||
# 内网 + TURN（推荐用于复杂内网/NAT）
|
||
bash ./deploy.sh --mode lan-http --with-turn
|
||
|
||
# 内网 HTTPS（自签，开发/受管环境，需显式开启 8443）
|
||
bash ./deploy.sh --mode lan-tls --enable-web-https --with-nginx
|
||
|
||
# 公网IP（无域名），含 TURN
|
||
bash ./deploy.sh --mode public --with-turn
|
||
|
||
# 公网域名（HTTPS + Nginx + TURN + SNI 443 分流，自动申请/续期证书）
|
||
bash ./deploy.sh --mode full --domain your-domain.com --with-nginx --with-turn --le-email you@domain.com
|
||
```
|
||
|
||
- 使用 Docker Compose V2（命令 `docker compose`）。
|
||
- full 模式自动申请 Let’s Encrypt 证书（webroot，无停机）并自动续期；默认启用 SNI 443 分流（`turn.your-domain.com` → coturn:5349，其余 → web:8443）。
|
||
|
||
## 模式一览
|
||
|
||
- lan-http：内网 HTTP；最快上手，默认不启用 TLS
|
||
- lan-tls：内网 HTTPS（自签，仅开发/受管环境）；默认不启 8443，需 `--enable-web-https` 显式开启；禁用 HSTS；不保证 turns:443
|
||
- public：公网 HTTP；开启 TURN；无域名也可使用（不提供 HTTPS/turns:443）
|
||
- full：域名 + HTTPS（Let’s Encrypt 自动签发/续期）+ TURN；默认启用 SNI 443 分流（可 `--no-sni443` 关闭）
|
||
|
||
## 🎯 部署优势
|
||
|
||
相比传统部署方式，Docker 部署具有以下优势：
|
||
|
||
| 对比项目 | 传统部署 | Docker 部署 |
|
||
| -------------- | -------------------- | ---------------- |
|
||
| **部署时间** | 30-60 分钟 | 5 分钟 |
|
||
| **技术要求** | Linux 运维经验 | 会用 Docker 即可 |
|
||
| **环境要求** | 公网 IP + 域名 | 内网即可使用 |
|
||
| **配置复杂度** | 10+个手动步骤 | 一键自动配置 |
|
||
| **成功率** | ~70% | >95% |
|
||
| **维护难度** | 需要手动管理多个服务 | 容器自动管理 |
|
||
|
||
## 📋 系统要求
|
||
|
||
### 最低配置
|
||
|
||
- **CPU**: 1 核
|
||
- **内存**: 512MB
|
||
- **磁盘**: 2GB 可用空间
|
||
- **网络**: 任意网络环境（内网/公网均可）
|
||
|
||
### 推荐配置
|
||
|
||
- **CPU**: 2 核及以上
|
||
- **内存**: 1GB 及以上
|
||
- **磁盘**: 5GB 及以上可用空间
|
||
- **网络**: 100Mbps 及以上
|
||
|
||
### 软件依赖
|
||
|
||
- Docker 20.10+
|
||
- Docker Compose 2.x（命令 `docker compose`）
|
||
- curl（用于健康检查，可选）
|
||
- openssl（用于证书工具，脚本会自动安装 certbot）
|
||
|
||
## 🚀 快速开始
|
||
|
||
### 1. 获取代码
|
||
|
||
```bash
|
||
# 克隆项目
|
||
git clone https://github.com/david-bai00/PrivyDrop.git
|
||
cd PrivyDrop
|
||
```
|
||
|
||
### 2. 一键部署（示例）
|
||
|
||
```bash
|
||
# 示例：公网域名（HTTPS + Nginx + TURN）
|
||
bash ./deploy.sh --mode full --domain your-domain.com --with-nginx --with-turn --le-email you@domain.com
|
||
```
|
||
|
||
## 📚 部署模式详解
|
||
|
||
### lan-http（内网 HTTP）
|
||
|
||
**适用场景**: 内网文件传输、个人使用、测试环境
|
||
|
||
```bash
|
||
bash ./deploy.sh --mode lan-http
|
||
```
|
||
|
||
**特性**:
|
||
|
||
- ✅ HTTP 访问
|
||
- ✅ 内网 P2P 传输
|
||
- ✅ 使用公共 STUN 服务器
|
||
- ✅ 零配置启动
|
||
|
||
### 公网模式
|
||
|
||
**适用场景**: 有公网 IP 但无域名的服务器
|
||
|
||
```bash
|
||
bash ./deploy.sh --mode public --with-turn --with-nginx
|
||
```
|
||
|
||
**特性**:
|
||
|
||
- ✅ HTTP 访问
|
||
- ✅ 内置 TURN 服务器
|
||
- ✅ 支持复杂网络环境
|
||
- ✅ 自动配置 NAT 穿透
|
||
|
||
### 完整模式（full）
|
||
|
||
**适用场景**: 生产环境、有域名的公网服务器
|
||
|
||
```bash
|
||
bash ./deploy.sh --mode full --domain your-domain.com --with-nginx --with-turn --le-email you@domain.com
|
||
```
|
||
|
||
**特性**:
|
||
|
||
- ✅ HTTPS 安全访问（Let’s Encrypt 自动签发/续期，无停机）
|
||
- ✅ Nginx 反向代理
|
||
- ✅ 内置 TURN 服务器（默认端口段 49152-49252/udp，可覆盖）
|
||
- ✅ SNI 443 分流（turn.<domain> → coturn:5349，其余 → web:8443）
|
||
- ✅ 完整生产环境配置
|
||
|
||
> 提示：脚本不再自动判断部署模式，请显式传递 `--mode lan-http|lan-tls|public|full`。若自动检测到的局域网 IP 与预期不符，可使用 `--local-ip 192.168.x.x` 进行覆盖。
|
||
|
||
## 🔧 高级配置
|
||
|
||
### 自定义端口
|
||
|
||
```bash
|
||
# 修改 .env 文件
|
||
FRONTEND_PORT=8080
|
||
BACKEND_PORT=8081
|
||
HTTP_PORT=8000
|
||
```
|
||
|
||
### 构建阶段代理（可选）
|
||
|
||
若需要在 Docker 构建时走网络代理，可在 `.env` 中设置以下变量，或者在执行 `deploy.sh` 之前通过环境变量导出。重新运行配置脚本时，这些字段会被保留：
|
||
|
||
```bash
|
||
HTTP_PROXY=http://你的代理:7890
|
||
HTTPS_PROXY=http://你的代理:7890
|
||
NO_PROXY=localhost,127.0.0.1,backend,frontend,redis,coturn
|
||
```
|
||
|
||
`docker compose` 会把这些变量作为 build args 传递给前后端镜像，Dockerfile 中会自动设置为环境变量，从而让 `npm`/`pnpm` 使用代理。若无需代理，保持为空即可。
|
||
|
||
### 常用开关
|
||
|
||
```bash
|
||
# 仅启用 Nginx
|
||
bash ./deploy.sh --with-nginx
|
||
|
||
# 启用 TURN（public/full 建议）
|
||
bash ./deploy.sh --with-turn
|
||
|
||
# 显式启用 SNI 443（full+domain 默认开启，可用 --no-sni443 关闭）
|
||
bash ./deploy.sh --with-sni443
|
||
|
||
# 调整 TURN 端口段（默认 49152-49252/udp）
|
||
bash ./deploy.sh --mode full --with-turn --turn-port-range 55000-55100
|
||
```
|
||
|
||
## 🌐 访问方式
|
||
|
||
- 启用 Nginx（推荐，同源网关）
|
||
- lan-http/public：`http://localhost`（或 `http://<公网IP>`）
|
||
- lan-tls（启用 `--enable-web-https`）：`https://localhost:8443`（或 `https://<LAN IP>:8443`）
|
||
- full（有域名）：`https://<your-domain>`（443）
|
||
- 健康检查：`curl -fsS http://localhost/api/health`（lan-http/public），`curl -kfsS https://localhost:8443/api/health`（lan-tls+https），`curl -fsS https://<domain>/api/health`（full）
|
||
|
||
- 未启用 Nginx（直连端口，仅调试）
|
||
- 前端：`http://localhost:3002`（或 `http://<LAN IP>:3002`）
|
||
- API：`http://localhost:3001`（或 `http://<LAN IP>:3001`）
|
||
- 注意：直连端口在生产/公网可能导致 CORS 或 404，不推荐对外使用。
|
||
|
||
### HTTPS 访问（lan-tls/full）
|
||
|
||
- lan-tls：开启 `--enable-web-https` 后通过 `https://localhost:8443` 访问（证书在 `docker/ssl/`）。首次访问需导入 `docker/ssl/ca-cert.pem` 到浏览器或系统信任。
|
||
- full：签发 Let’s Encrypt 后通过 `https://<your-domain>` 访问（443）。
|
||
|
||
## 🔍 管理命令
|
||
|
||
### 查看服务状态
|
||
|
||
```bash
|
||
docker compose ps
|
||
```
|
||
|
||
### 查看服务日志
|
||
|
||
```bash
|
||
# 查看所有服务日志
|
||
docker compose logs -f
|
||
|
||
# 查看特定服务日志
|
||
docker compose logs -f backend
|
||
docker compose logs -f frontend
|
||
docker compose logs -f redis
|
||
```
|
||
|
||
### 重启服务
|
||
|
||
```bash
|
||
# 重启所有服务
|
||
docker compose restart
|
||
|
||
# 重启特定服务
|
||
docker compose restart backend
|
||
```
|
||
|
||
### 停止服务
|
||
|
||
```bash
|
||
# 停止服务但保留数据
|
||
docker compose stop
|
||
|
||
# 停止服务并删除容器
|
||
docker compose down
|
||
```
|
||
|
||
### 完全清理
|
||
|
||
```bash
|
||
# 清理所有容器、镜像和数据
|
||
bash ./deploy.sh --clean
|
||
```
|
||
|
||
## 🛠️ 故障排除
|
||
|
||
### 常见问题
|
||
|
||
#### 1. 端口被占用
|
||
|
||
**现象**: 部署时提示端口已被占用
|
||
|
||
```
|
||
⚠️ 以下端口已被占用: 3002, 3001
|
||
```
|
||
|
||
**解决方案**:
|
||
|
||
```bash
|
||
# 方法1: 清理旧容器
|
||
bash ./deploy.sh --clean # 或 docker compose down
|
||
|
||
# 方法2: 查找并结束占用进程
|
||
sudo ss -tulpn | grep :3002
|
||
sudo kill -9 <PID>
|
||
|
||
# 方法3: 如仍冲突，再调整端口
|
||
vim .env # 修改 FRONTEND_PORT / BACKEND_PORT
|
||
```
|
||
|
||
#### 2. 内存不足
|
||
|
||
**现象**: 容器启动失败或频繁重启
|
||
|
||
**解决方案**:
|
||
|
||
```bash
|
||
# 检查内存使用
|
||
free -h
|
||
|
||
# 添加交换空间 (临时解决)
|
||
sudo fallocate -l 1G /swapfile
|
||
sudo chmod 600 /swapfile
|
||
sudo mkswap /swapfile
|
||
sudo swapon /swapfile
|
||
```
|
||
|
||
#### 3. Docker 权限问题
|
||
|
||
**现象**: 提示权限不足
|
||
|
||
**解决方案**:
|
||
|
||
```bash
|
||
# 将用户添加到docker组
|
||
sudo usermod -aG docker $USER
|
||
|
||
# 重新登录或刷新组权限
|
||
newgrp docker
|
||
```
|
||
|
||
#### 4. 服务无法访问
|
||
|
||
**现象**: 浏览器无法打开页面
|
||
|
||
**解决方案**:
|
||
|
||
```bash
|
||
# 1. 检查服务状态
|
||
docker compose ps
|
||
|
||
# 2. 检查健康状态
|
||
curl http://localhost:3001/health
|
||
curl http://localhost:3002/api/health
|
||
|
||
# 3. 查看详细日志
|
||
docker compose logs -f
|
||
|
||
# 4. 检查防火墙
|
||
sudo ufw status
|
||
```
|
||
|
||
#### 5. WebRTC 连接失败
|
||
|
||
**现象**: 无法建立 P2P 连接
|
||
|
||
**解决方案**:
|
||
|
||
```bash
|
||
# 启用TURN服务器
|
||
bash ./deploy.sh --with-turn
|
||
|
||
# 检查网络连接
|
||
curl -I http://localhost:3001/api/get_room
|
||
```
|
||
|
||
### 健康检查
|
||
|
||
项目提供了完整的健康检查功能：
|
||
|
||
```bash
|
||
# 运行健康检查测试
|
||
bash ./test-health-apis.sh
|
||
|
||
# 手动检查各服务（直连端口）
|
||
curl http://localhost:3001/health # 后端基础检查（直连）
|
||
curl http://localhost:3001/health/detailed # 后端详细检查（直连）
|
||
curl http://localhost:3002/api/health # 前端检查（直连）
|
||
|
||
# 同源网关（启用 Nginx）
|
||
curl -fsS http://localhost/api/health # lan-http/public
|
||
curl -kfsS https://localhost:8443/api/health # lan-tls (https)
|
||
```
|
||
|
||
### 性能监控
|
||
|
||
```bash
|
||
# 查看容器资源使用
|
||
docker stats
|
||
|
||
# 查看磁盘使用
|
||
docker system df
|
||
|
||
# 清理未使用的资源
|
||
docker system prune -f
|
||
```
|
||
|
||
## 📊 性能优化
|
||
|
||
### 生产环境优化
|
||
|
||
1. **启用 Nginx 缓存**:
|
||
|
||
```bash
|
||
bash ./deploy.sh --with-nginx
|
||
```
|
||
|
||
2. **配置资源限制**:
|
||
|
||
```yaml
|
||
# 在 docker-compose.yml 中添加
|
||
services:
|
||
backend:
|
||
deploy:
|
||
resources:
|
||
limits:
|
||
memory: 256M
|
||
reservations:
|
||
memory: 128M
|
||
```
|
||
|
||
3. **启用日志轮转**:
|
||
|
||
```bash
|
||
# 配置日志大小限制
|
||
echo '{"log-driver":"json-file","log-opts":{"max-size":"10m","max-file":"3"}}' | sudo tee /etc/docker/daemon.json
|
||
sudo systemctl restart docker
|
||
```
|
||
|
||
### 网络优化
|
||
|
||
1. **使用专用网络**:
|
||
|
||
```yaml
|
||
networks:
|
||
privydrop-network:
|
||
driver: bridge
|
||
ipam:
|
||
config:
|
||
- subnet: 172.20.0.0/16
|
||
```
|
||
|
||
2. **启用 HTTP/2**:
|
||
|
||
```bash
|
||
# 自动启用 (需要 HTTPS)
|
||
bash ./deploy.sh --mode full --with-nginx
|
||
```
|
||
|
||
## 🔒 HTTPS 与安全
|
||
|
||
### 内网 HTTPS（lan-tls，自签，开发/受管环境）
|
||
|
||
- 默认不启 8443；需 `--enable-web-https` 显式开启：
|
||
|
||
```bash
|
||
bash ./deploy.sh --mode lan-tls --enable-web-https --with-nginx
|
||
```
|
||
|
||
- 仅用于开发或受管终端（全员导入内部 CA）；禁用 HSTS；不保证 `turns:443`；受限网络（仅 443 出口）应使用 full（域名 + 受信证书 + SNI 443）。
|
||
|
||
使用说明（强烈建议逐条完成）
|
||
|
||
1) 导入自签 CA 证书（必做）
|
||
- 证书位置：`docker/ssl/ca-cert.pem`
|
||
- 浏览器导入：
|
||
- Chrome/Edge：设置 → 隐私与安全 → 安全 → 管理证书 → “受信任的根证书颁发机构” → 导入 `ca-cert.pem`
|
||
- macOS：钥匙串访问 → System → 证书 → 导入 `ca-cert.pem` → 设置“始终信任”
|
||
- Linux（系统层）：
|
||
- `sudo cp docker/ssl/ca-cert.pem /usr/local/share/ca-certificates/privydrop-ca.crt`
|
||
- `sudo update-ca-certificates`
|
||
- 未导入时，浏览器访问 HTTPS 会提示“证书无效/不受信任”，API 请求也会失败。
|
||
|
||
2) 访问方式（默认端口与路径）
|
||
- Nginx 反代：`http://localhost`
|
||
- HTTPS（Web）：`https://localhost:8443`、`https://<局域网IP>:8443`
|
||
- 前端直连（可选）：`http://localhost:3002`、`http://<局域网IP>:3002`
|
||
- 说明：lan-tls 下未开启 443；HTTPS 统一走 8443。
|
||
|
||
3) 跨域（CORS）说明
|
||
- 为方便开发与调试，脚本已默认放开常见来源：`https://<局域网IP>:8443`、`https://localhost:8443`、`http://localhost`、`http://<局域网IP>`、`http://localhost:3002`、`http://<局域网IP>:3002`。
|
||
- 若仍需最小化来源，请在 `.env` 中精准收敛 `CORS_ORIGIN`，并 `docker compose restart backend`。
|
||
|
||
4) 健康检查
|
||
- `curl -kfsS https://localhost:8443/api/health` → 200
|
||
- `bash ./test-health-apis.sh` → 所有测试应通过（前端 detailed 健康已在容器内信任自签 CA）。
|
||
|
||
5) 部署提示
|
||
- 脚本会只显示可访问的 Nginx 入口；lan-tls 下将显示明确的 `https://localhost:8443`（如存在局域网 IP 也将显示 `https://<IP>:8443`）。
|
||
|
||
### 公网域名部署（HTTPS + Nginx）快速测试
|
||
|
||
1) 将域名 A 记录解析至服务器 IP（可选：`turn.<your-domain>` 指向相同 IP）
|
||
|
||
2) 运行：
|
||
|
||
```bash
|
||
./deploy.sh --mode full --domain <your-domain> --with-nginx --with-turn --le-email you@domain.com
|
||
```
|
||
|
||
3) 放行端口：`80`, `443`, `3478/udp`, `5349/tcp`, `5349/udp`
|
||
|
||
4) 验证：访问 `https://<your-domain>`，`/api/health` 返回 200；打开浏览器 `webrtc-internals` 观察是否出现 `relay` 候选（TURN）
|
||
|
||
### 证书自动化（Let’s Encrypt）
|
||
|
||
full 模式自动申请并续期证书：
|
||
|
||
- 首次签发：webroot 模式（无停机），系统证书在 `/etc/letsencrypt/live/<domain>/`，脚本复制到 `docker/ssl/` 并启用 443；
|
||
- 续期：`certbot.timer` 或 `/etc/cron.d/certbot` 每日尝试 `certbot renew`；deploy-hook 自动复制新证书并热重载 Nginx/Coturn；
|
||
- 证书谱系（-0001/-0002）已自动适配，无需手动处理。
|
||
|
||
### 网络安全
|
||
|
||
1. **防火墙配置**:
|
||
|
||
```bash
|
||
# Ubuntu/Debian
|
||
sudo ufw allow 80/tcp
|
||
sudo ufw allow 443/tcp
|
||
sudo ufw allow 3478/udp # TURN服务器
|
||
```
|
||
|
||
2. **容器网络隔离**:
|
||
- 所有服务运行在独立网络中
|
||
- 仅暴露必要端口
|
||
- 内部服务使用容器名通信
|
||
|
||
## 📈 监控和日志
|
||
|
||
### 日志管理
|
||
|
||
所有服务日志统一存储在 `logs/` 目录：
|
||
|
||
```
|
||
logs/
|
||
├── nginx/ # Nginx访问和错误日志
|
||
├── backend/ # 后端应用日志
|
||
├── frontend/ # 前端应用日志
|
||
└── coturn/ # TURN服务器日志
|
||
```
|
||
|
||
## 🔄 更新和维护
|
||
|
||
### 更新应用
|
||
|
||
```bash
|
||
# 拉取最新代码
|
||
git pull origin main
|
||
|
||
# 重新部署
|
||
bash ./deploy.sh
|
||
```
|
||
|
||
### 数据备份
|
||
|
||
```bash
|
||
# 备份Redis数据
|
||
docker compose exec redis redis-cli BGSAVE
|
||
|
||
# 备份SSL证书
|
||
tar -czf ssl-backup.tar.gz docker/ssl/
|
||
|
||
# 备份配置文件
|
||
cp .env .env.backup
|
||
```
|
||
|
||
### 定期维护
|
||
|
||
```bash
|
||
# 清理未使用的镜像和容器
|
||
docker system prune -f
|
||
|
||
# 更新基础镜像
|
||
docker compose pull
|
||
docker compose up -d
|
||
```
|
||
|
||
## 🆘 获取帮助
|
||
|
||
### 命令行帮助
|
||
|
||
```bash
|
||
bash ./deploy.sh --help
|
||
```
|
||
|
||
### 在线资源
|
||
|
||
- [项目主页](https://github.com/david-bai00/PrivyDrop)
|
||
- [在线演示](https://www.privydrop.app/)
|
||
- [问题反馈](https://github.com/david-bai00/PrivyDrop/issues)
|
||
|
||
### 社区支持
|
||
|
||
- GitHub Issues: 技术问题和 bug 报告
|
||
|
||
### 其他提示
|
||
|
||
- Docker 环境默认关闭 Next.js Image 优化（`NEXT_IMAGE_UNOPTIMIZED=true`），以避免容器内对公网 IP 回环抓取导致 `/_next/image` 502；如需开启，将其设为 `false` 并重新构建。
|
||
- 启用 `--with-nginx` 时，前端会构建为同源 API（相对路径 `/api`、`/socket.io/`）；请优先使用脚本输出的网关入口，不要直接使用 `:3002/:3001` 对外访问，否则可能触发 CORS 或 404。
|