Files
jiedian/docs/GUIDE.md
T
dekun 78b85c0d83 feat: enable HTTPS admin panel on port 443 for new deployments
Add Nginx SSL panel config, enable-panel-https.sh, secure Flask cookies, and update docs for https login.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-06-28 00:46:08 +08:00

194 lines
4.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 使用说明
本文档面向日常使用 jiedian 的用户,说明管理面板、节点与客户端的基本操作。
---
## 一、项目是什么
**jiedian** 是一套自建代理方案:
- **服务端**VPS 上运行 sing-box,提供 **Hysteria2Hy2** 协议
- **管理面板**:Web 界面管理节点、复制链接、查看在线与流量
- **客户端**v2rayNWindows)、v2rayNGAndroid)、ShadowrocketiOS)等导入 Hy2 链接即可使用
> 当前版本 **仅支持 Hysteria2**,不再提供 VLESS/Reality。
---
## 二、管理面板
### 访问地址
```
https://你的域名/<PANEL_PATH>/
```
- 使用 **HTTPS**443 端口),密码加密传输
- 若输入 `http://` 会自动跳转到 HTTPS
- `PANEL_PATH``/opt/jiedian/.env` 中:
```bash
grep PANEL_PATH /opt/jiedian/.env
```
### 登录
使用 `.env` 中的 `PANEL_USERNAME``PANEL_PASSWORD`
### 面板功能
| 功能 | 说明 |
|------|------|
| 节点列表 | 查看各设备节点状态、连接数、实时/累计流量 |
| 添加节点 | 为每台设备创建独立 Hy2 账号 |
| 复制链接 | 一键复制 `hy2://` 分享链接 |
| 删除节点 | 删除后对应链接立即失效(至少保留 1 个节点) |
---
## 三、节点与设备
### 一设备一节点(推荐)
每个节点包含:
- 独立的 **Hy2 密码**
- 独立的 **UDP 端口**(按创建顺序递增)
| 节点顺序 | Hy2 端口 | 示例 |
|----------|----------|------|
| 第 1 个 | 8443 | 手机 |
| 第 2 个 | 8444 | 电脑 |
| 第 3 个 | 8445 | 平板 |
### 添加节点
1. 面板点击 **「+ 添加节点」**
2. 输入名称(如「手机」「电脑」)
3. 等待约 5–10 秒页面刷新(后台重载 sing-box)
4. 点击 **「复制」** 获取 Hy2 链接
5. 在客户端 **从剪贴板导入**
### 不要共用链接
同一 `hy2://` 链接 **技术上可多台设备同时连**,但不建议:
- 流量统计无法区分设备
- 带宽互相抢占
- 链接泄露影响所有共用设备
---
## 四、客户端配置
详细步骤见 [client-import.md](client-import.md)。
### 快速步骤
1. 在面板复制 `hy2://...` 链接
2. 打开客户端 → **从剪贴板导入**
3. 设为活动节点并连接
### 链接格式
```
hy2://密码@域名:端口?sni=域名#节点名-Hy2
```
示例:
```
hy2://xxxx@66.hyf2.cc:8443?sni=66.hyf2.cc#默认节点-Hy2
```
**注意:**
- 地址是 **域名**`66.hyf2.cc`),不是 IP
- **SNI** 与域名相同
- 端口以面板显示为准(多节点时 8444、8445…)
### 推荐客户端
| 平台 | 客户端 |
|------|--------|
| Windows | [v2rayN](https://github.com/2dust/v2rayN/releases) |
| Android | [v2rayNG](https://github.com/2dust/v2rayNG/releases) |
| iOS | Shadowrocket / Streisand |
| macOS | v2rayN / Nekoray / sing-box |
---
## 五、Hy2 稳定性说明
Hysteria2 基于 **UDP**,特点:
| 优点 | 说明 |
|------|------|
| 弱网表现好 | 高丢包环境下通常比 TCP 代理更流畅 |
| 部署简单 | 无需 Reality 密钥、SNI 等复杂参数 |
| 本方案已验证 | 同 VPS 下 Hy2 通常比 VLESS 更易连通 |
| 注意 | 说明 |
|------|------|
| UDP 依赖 | 部分网络可能对 UDP 限速,可换 WiFi/热点试 |
| 证书 | 依赖域名与 Let's Encryptacme.sh 会自动续期 |
| 安全组 | 必须放行 84438499/UDP |
---
## 六、日常维护
### 查看服务状态
```bash
systemctl status sing-box jiedian-panel
```
### 更新代码(VPS 上)
```bash
cd /opt/jiedian
git pull
python3 scripts/render-server.py
systemctl restart sing-box jiedian-panel
```
### 忘记面板密码
```bash
grep PANEL_PASSWORD /opt/jiedian/.env
# 或重新生成
bash /opt/jiedian/scripts/generate-keys.sh
systemctl restart jiedian-panel
```
### 换设备 / 丢链接
在面板找到对应节点,重新 **复制** Hy2 链接导入即可,无需改服务端。
### 删除旧设备
面板删除该节点 → 客户端删除对应配置。
---
## 七、安全建议
1. **不要公开分享**节点链接
2. 面板使用随机 `PANEL_PATH`,不要对外暴露
3. 可设置 `PANEL_ALLOW_IP` 限制面板访问来源
4. 不要将 `.env` 或节点链接提交到公开仓库
5. 定期 `git pull` 更新到最新版本
---
## 八、文档索引
| 文档 | 内容 |
|------|------|
| [DEPLOY.md](DEPLOY.md) | VPS 部署、升级、验证 |
| [client-import.md](client-import.md) | 各平台客户端导入 |
| [troubleshooting.md](troubleshooting.md) | 故障排查 |
| [STACK.md](STACK.md) | 技术架构 |