feat: initial commit

This commit is contained in:
root
2026-06-14 14:00:24 +08:00
commit 72d388f642
118 changed files with 39015 additions and 0 deletions
+90
View File
@@ -0,0 +1,90 @@
# IPCLOAKAPI 宝塔一键部署说明
## 适用场景
在一台宝塔服务器上**安装一次**,之后新建的 PHP 网站可通过钩子自动接入 Cloak 流量判定(需在后台绑定域名与配置)。
## 三步安装(客户向)
### 第 1 步:上传并执行安装脚本
1. 将整个项目上传到服务器(或通过 Git 拉取)。
2. SSH 登录服务器,执行:
```bash
cd /path/to/cloaka
sudo bash deploy/baota/install_bt.sh
```
3. 按提示输入**管理后台域名**(例如 `cloak-admin.你的域名.com`)。脚本会把程序安装到 `/www/cloaka`(可改 `--root`)。
### 第 2 步:完成 Web 安装向导
浏览器打开:
```text
https://cloak-admin.你的域名.com/install.php
```
填写 MySQL、后台密码、API 秘钥(CHECK_KEY),点击安装。
### 第 3 步:为每个业务站配置
对每个投流域名:
1. **先在宝塔**:网站 → 添加站点 → 填写域名 → 申请 **SSL**(必须)。
2. **再在后台**`dashboard.php`**站点域名** → 添加相同域名。
3. **新建或编辑配置****关联域名** 选择该域名 → 填写仿品/正品链接 → 保存。
> 未添加域名时,广告链接默认使用**当前访问后台的域名**。
## 新建宝塔网站时会发生什么
安装脚本会在 `/www/server/panel/hook/` 注册 `cloaka_post_site.sh`
- 为新站点 Nginx 配置追加 Cloak 路由片段(请求走 `/www/cloaka/ip_check.php`)。
- 尝试在数据库 `cloak_site_domains` 登记该域名(需已完成 install.php)。
## 手动绑定已有站点
编辑站点 Nginx 配置,在 `server { }` 内追加(注意修改 PHP 版本路径):
```nginx
# BEGIN IPCLOAKAPI
# 内容见 /www/cloaka/deploy/baota/nginx/cloaka-site.conf.installed
# END IPCLOAKAPI
```
或重新运行:
```bash
sudo CLOAK_ROOT=/www/cloaka bash /www/cloaka/deploy/baota/hook/post_site.sh 站点域名 /www/wwwroot/站点域名
```
## 升级
```bash
sudo bash deploy/baota/install_bt.sh --upgrade --source /path/to/new/cloaka
```
不会覆盖 `cong.php``.install.lock``check_config/*_config.php`
## 目录说明
| 路径 | 说明 |
|------|------|
| `/www/cloaka` | 程序主目录(默认) |
| `deploy/baota/nginx/cloaka-site.conf` | 业务站 Nginx 模板 |
| `deploy/baota/nginx/cloaka-admin.conf` | 管理站 Nginx 补充 |
| `deploy/baota/hook/post_site.sh` | 建站后钩子 |
## 常见问题
**Q:访问业务站 502**
检查 `cloaka-site.conf.installed` 中 PHP include 路径是否与站点 PHP 版本一致(安装脚本会按 82/83/81 检测)。
**Q:配置不生效?**
确认后台已为该域名**关联配置**,且 `check_config/配置名_config.php` 存在。
**Q:广告链接域名不对?**
在编辑配置中选择正确的「关联域名」;未选择时使用后台当前访问域名。