103 lines
2.1 KiB
Markdown
103 lines
2.1 KiB
Markdown
# 生产环境部署指南
|
||
|
||
## 安全配置步骤
|
||
|
||
### 1. 配置环境变量
|
||
|
||
复制环境变量模板并修改敏感信息：
|
||
|
||
```bash
|
||
# 复制模板文件
|
||
cp .env.example .env
|
||
|
||
# 编辑 .env 文件，修改以下敏感配置：
|
||
nano .env
|
||
```
|
||
|
||
**必须修改的配置：**
|
||
- `FILE_LIST_PASSWORD` - 设置强密码（建议使用随机生成的密码）
|
||
|
||
**生成强密码的方法：**
|
||
```bash
|
||
# 生成密码
|
||
openssl rand -base64 32
|
||
```
|
||
|
||
### 2. 文件权限设置
|
||
|
||
```bash
|
||
# 创建文件目录（根据 .env 中的 FILES_DIR 配置）
|
||
mkdir -p ${FILES_DIR:-./files}
|
||
|
||
# 设置适当的权限
|
||
chmod 755 files
|
||
```
|
||
|
||
### 3. 部署到服务器
|
||
|
||
```bash
|
||
# 克隆仓库
|
||
git clone https://github.com/YOUR_USERNAME/REPO_NAME.git
|
||
cd REPO_NAME
|
||
|
||
# 配置环境变量
|
||
cp .env.example .env
|
||
# 编辑 .env 文件...
|
||
|
||
# 构建并启动
|
||
docker-compose up -d --build
|
||
```
|
||
|
||
### 4. 验证部署
|
||
|
||
```bash
|
||
# 检查服务状态
|
||
docker-compose ps
|
||
|
||
# 查看日志
|
||
docker-compose logs -f
|
||
|
||
# 测试 API
|
||
curl http://localhost/api/health
|
||
```
|
||
|
||
## 环境变量说明
|
||
|
||
| 变量名 | 说明 | 默认值 | 是否必须修改 |
|
||
|--------|------|--------|------------|
|
||
| `APP_NAME` | 应用名称 | Vue3 Python Notepad | 否 |
|
||
| `FILE_LIST_PASSWORD` | 文件列表访问密码 | your_secure_password_here | **是** |
|
||
| `EXTERNAL_PORT` | 容器对外暴露的端口 | 80 | 否 |
|
||
| `FILES_DIR` | 文件存储目录（宿主机路径） | ./files | 否 |
|
||
|
||
## 安全建议
|
||
|
||
1. **定期更换密码**
|
||
- 建议每 3 个月更换一次 `FILE_LIST_PASSWORD`
|
||
|
||
2. **使用 HTTPS**
|
||
- 配置反向代理（Nginx/Traefik）
|
||
- 申请 SSL 证书（Let's Encrypt）
|
||
|
||
4. **备份**
|
||
- 定期备份 `FILES_DIR` 配置的目录
|
||
- 备份 `.env` 文件（存储在安全位置）
|
||
|
||
4. **监控**
|
||
- 监控容器资源使用
|
||
- 设置日志轮转
|
||
- 配置告警机制
|
||
|
||
## 故障排除
|
||
|
||
1. **密码错误**
|
||
- 检查 `.env` 文件中的 `FILE_LIST_PASSWORD`
|
||
- 重启容器：`docker-compose restart backend`
|
||
|
||
2. **认证错误**
|
||
- 检查 `.env` 文件中的 `FILE_LIST_PASSWORD`
|
||
- 清除浏览器 localStorage 中的 token
|
||
|
||
3. **权限问题**
|
||
- 确保 `files` 目录有写权限
|
||
- 检查 Docker 容器用户权限 |