docs: Add one-click installation script for PPanel with Docker support
- Introduced `install-ppanel.sh` script for automated installation of PPanel using Docker Compose. - Updated installation documentation to include one-click deployment options and detailed configuration steps. - Enhanced configuration files for MySQL and Redis with necessary parameters. - Improved Docker Compose setup with health checks and custom network configurations. - Added instructions for firewall configuration and reverse proxy setup for production environments. - Included troubleshooting tips and advanced options for non-interactive installations and proxy environments.
This commit is contained in:
web@ppanel
@@ -0,0 +1,289 @@
|
||||
# 一键部署
|
||||
|
||||
使用自动化安装脚本快速部署 PPanel。适合快速测试或生产环境部署。
|
||||
|
||||
## 前置条件
|
||||
|
||||
- 干净的 Linux 服务器 (Ubuntu 20.04+, Debian 10+, CentOS 8+)
|
||||
- Root 或 sudo 访问权限
|
||||
- 基本的网络连接
|
||||
|
||||
## 安装步骤
|
||||
|
||||
### 方式一：完整安装（推荐）
|
||||
|
||||
一条命令同时安装 Docker 和 PPanel：
|
||||
|
||||
```bash
|
||||
curl -fsSL https://ppanel.dev/scripts/zh/install-docker.sh | sudo bash && \
|
||||
curl -fsSL https://ppanel.dev/scripts/zh/install-ppanel.sh | bash
|
||||
```
|
||||
|
||||
### 方式二：分步安装
|
||||
|
||||
如果你希望分别安装各个组件：
|
||||
|
||||
#### 步骤 1: 安装 Docker 和 Docker Compose
|
||||
|
||||
```bash
|
||||
curl -fsSL https://ppanel.dev/scripts/zh/install-docker.sh | sudo bash
|
||||
```
|
||||
|
||||
此脚本将会：
|
||||
- ✅ 自动检测你的操作系统
|
||||
- ✅ 安装 Docker Engine 和 Docker Compose Plugin
|
||||
- ✅ 配置 Docker 服务开机自启
|
||||
- ✅ 将当前用户添加到 docker 组
|
||||
- ✅ 验证安装是否成功
|
||||
|
||||
#### 步骤 2: 安装 PPanel
|
||||
|
||||
```bash
|
||||
curl -fsSL https://ppanel.dev/scripts/zh/install-ppanel.sh | bash
|
||||
```
|
||||
|
||||
此脚本将会：
|
||||
- ✅ 检查 Docker 环境
|
||||
- ✅ 检查端口可用性
|
||||
- ✅ 创建安装目录
|
||||
- ✅ 交互式配置（MySQL、Redis）
|
||||
- ✅ 自动生成 JWT 密钥
|
||||
- ✅ 创建 docker-compose.yml
|
||||
- ✅ 拉取 Docker 镜像并启动服务
|
||||
- ✅ 显示访问信息
|
||||
|
||||
## 安装时的配置
|
||||
|
||||
安装脚本会提示你输入以下信息：
|
||||
|
||||
### MySQL 配置（必需）
|
||||
|
||||
```
|
||||
MySQL 地址 (默认: localhost:3306):
|
||||
MySQL 用户名 (默认: ppanel):
|
||||
MySQL 密码: [你的密码]
|
||||
MySQL 数据库名 (默认: ppanel):
|
||||
```
|
||||
|
||||
### Redis 配置（必需）
|
||||
|
||||
```
|
||||
Redis 地址 (默认: localhost:6379):
|
||||
Redis 密码 (可选): [你的密码]
|
||||
Redis DB (默认: 0):
|
||||
```
|
||||
|
||||
::: tip 提示
|
||||
安装脚本会自动为你生成一个安全的 JWT 密钥。
|
||||
:::
|
||||
|
||||
## 自定义安装目录
|
||||
|
||||
默认情况下，PPanel 安装到 `~/ppanel`。你可以指定自定义目录：
|
||||
|
||||
```bash
|
||||
INSTALL_DIR=/opt/ppanel curl -fsSL https://ppanel.dev/scripts/zh/install-ppanel.sh | bash
|
||||
```
|
||||
|
||||
## 自定义端口
|
||||
|
||||
默认情况下，PPanel 监听 8080 端口。要使用其他端口：
|
||||
|
||||
```bash
|
||||
HOST_PORT=3000 curl -fsSL https://ppanel.dev/scripts/zh/install-ppanel.sh | bash
|
||||
```
|
||||
|
||||
## 部署后配置
|
||||
|
||||
### 访问你的安装
|
||||
|
||||
安装成功后，你可以访问：
|
||||
|
||||
- **用户面板**: `http://your-server-ip:8080`
|
||||
- **管理后台**: `http://your-server-ip:8080/admin/`
|
||||
|
||||
### 常用命令
|
||||
|
||||
安装脚本会显示这些有用的命令：
|
||||
|
||||
```bash
|
||||
# 进入安装目录
|
||||
cd ~/ppanel
|
||||
|
||||
# 查看服务状态
|
||||
docker compose ps
|
||||
|
||||
# 查看日志
|
||||
docker compose logs -f
|
||||
|
||||
# 重启服务
|
||||
docker compose restart
|
||||
|
||||
# 停止服务
|
||||
docker compose stop
|
||||
|
||||
# 启动服务
|
||||
docker compose start
|
||||
```
|
||||
|
||||
### 配置防火墙
|
||||
|
||||
**Ubuntu/Debian:**
|
||||
```bash
|
||||
sudo ufw allow 8080/tcp
|
||||
sudo ufw status
|
||||
```
|
||||
|
||||
**CentOS/RHEL:**
|
||||
```bash
|
||||
sudo firewall-cmd --permanent --add-port=8080/tcp
|
||||
sudo firewall-cmd --reload
|
||||
```
|
||||
|
||||
### 设置反向代理（推荐）
|
||||
|
||||
生产环境部署建议配置带 HTTPS 的反向代理：
|
||||
|
||||
**Nginx:**
|
||||
```nginx
|
||||
server {
|
||||
listen 80;
|
||||
server_name your-domain.com;
|
||||
return 301 https://$server_name$request_uri;
|
||||
}
|
||||
|
||||
server {
|
||||
listen 443 ssl http2;
|
||||
server_name your-domain.com;
|
||||
|
||||
ssl_certificate /path/to/cert.pem;
|
||||
ssl_certificate_key /path/to/key.pem;
|
||||
|
||||
location / {
|
||||
proxy_pass http://localhost:8080;
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
**Caddy:**
|
||||
```
|
||||
your-domain.com {
|
||||
reverse_proxy localhost:8080
|
||||
}
|
||||
```
|
||||
|
||||
## 升级
|
||||
|
||||
直接从**管理后台**主页升级 PPanel。在仪表盘主页可以检查新版本并一键升级。
|
||||
|
||||
::: tip 提示
|
||||
系统会自动处理升级过程，包括拉取新镜像和重启服务。
|
||||
:::
|
||||
|
||||
## 故障排除
|
||||
|
||||
### 安装失败
|
||||
|
||||
如果安装失败，请检查：
|
||||
|
||||
1. **网络连接**: 确保服务器可以访问 Docker Hub 和 GitHub
|
||||
2. **系统要求**: 验证你的操作系统是否支持
|
||||
3. **权限**: 确保你有 sudo/root 访问权限
|
||||
4. **端口可用性**: 检查端口 8080 是否可用
|
||||
|
||||
### Docker 未找到
|
||||
|
||||
如果出现 "Docker not found" 错误：
|
||||
|
||||
```bash
|
||||
# 检查 Docker 是否已安装
|
||||
docker --version
|
||||
|
||||
# 如果未安装，先运行 Docker 安装脚本
|
||||
curl -fsSL https://ppanel.dev/scripts/zh/install-docker.sh | sudo bash
|
||||
```
|
||||
|
||||
### 服务无法启动
|
||||
|
||||
查看日志检查错误：
|
||||
|
||||
```bash
|
||||
cd ~/ppanel
|
||||
docker compose logs -f
|
||||
```
|
||||
|
||||
常见问题：
|
||||
- MySQL 连接失败：检查 MySQL 凭据
|
||||
- Redis 连接失败：检查 Redis 凭据
|
||||
- 端口已被占用：更改 HOST_PORT
|
||||
|
||||
### 权限被拒绝
|
||||
|
||||
如果遇到 Docker 权限错误：
|
||||
|
||||
```bash
|
||||
# 将用户添加到 docker 组
|
||||
sudo usermod -aG docker $USER
|
||||
|
||||
# 注销并重新登录，或运行：
|
||||
newgrp docker
|
||||
```
|
||||
|
||||
## 卸载
|
||||
|
||||
完全移除 PPanel：
|
||||
|
||||
```bash
|
||||
cd ~/ppanel
|
||||
docker compose down
|
||||
cd ~
|
||||
rm -rf ~/ppanel
|
||||
```
|
||||
|
||||
## 高级选项
|
||||
|
||||
### 非交互式安装
|
||||
|
||||
对于自动化部署，可以使用环境变量预配置设置：
|
||||
|
||||
```bash
|
||||
export INSTALL_DIR=/opt/ppanel
|
||||
export HOST_PORT=8080
|
||||
export MYSQL_ADDR=localhost:3306
|
||||
export MYSQL_USER=ppanel
|
||||
export MYSQL_PASSWORD=your-password
|
||||
export MYSQL_DB=ppanel
|
||||
export REDIS_HOST=localhost:6379
|
||||
export REDIS_PASS=your-redis-password
|
||||
export REDIS_DB=0
|
||||
|
||||
curl -fsSL https://ppanel.dev/scripts/zh/install-ppanel.sh | bash
|
||||
```
|
||||
|
||||
### 代理环境下安装
|
||||
|
||||
如果你的服务器在代理后面：
|
||||
|
||||
```bash
|
||||
export HTTP_PROXY=http://proxy.example.com:8080
|
||||
export HTTPS_PROXY=http://proxy.example.com:8080
|
||||
|
||||
curl -fsSL https://ppanel.dev/scripts/zh/install-docker.sh | sudo bash
|
||||
curl -fsSL https://ppanel.dev/scripts/zh/install-ppanel.sh | bash
|
||||
```
|
||||
|
||||
## 下一步
|
||||
|
||||
- [配置指南](/zh/guide/configuration) - 自定义你的 PPanel 设置
|
||||
- [管理后台](/zh/admin/dashboard) - 开始管理你的面板
|
||||
- [API 参考](/zh/api/reference) - 与你的应用集成
|
||||
|
||||
## 需要帮助？
|
||||
|
||||
- 查看 [GitHub Issues](https://github.com/perfect-panel/ppanel/issues)
|
||||
- 查看安装日志
|
||||
- 加入我们的社区获取支持
|
||||
Reference in New Issue
Block a user