flvx/doc/install.md

安装部署指南

本文档介绍如何部署 FLVX 面板端及节点端。

一、面板端部署

面板端负责管理用户、节点和转发规则。

1. 环境要求

• 操作系统：Linux (推荐 Debian 10+ / Ubuntu 20.04+)
• 必须安装 Docker 和 Docker Compose

2. 一键安装脚本

使用以下命令即可快速安装面板：

curl -L https://raw.githubusercontent.com/Sagit-chu/flux-panel/main/panel_install.sh -o panel_install.sh && chmod +x panel_install.sh && ./panel_install.sh

安装过程中会提示输入以下信息：

• 前端端口: 默认为 6366
• 后端端口: 默认为 6365

脚本会自动检测系统是否支持 IPv6，并自动配置 Docker 的 IPv6 支持。

3. 访问面板

安装完成后，访问： http://<服务器IP>:<前端端口> (默认: http://<服务器IP>:6366)

默认管理员账号：

• 用户名: admin_user
• 密码: admin_user

⚠️ 注意: 首次登录后，请务必在“个人中心”或“设置”中修改默认密码！

4. 维护命令

再次运行 ./panel_install.sh 脚本可以看到管理菜单：

1. 安装面板
2. 更新面板
3. 卸载面板

---

二、节点端部署

节点端运行在实际进行流量转发的服务器上，需要连接到面板端进行管理。

1. 获取接入密钥

1. 登录面板端。
2. 进入 节点管理 (Node) 页面。
3. 点击 添加节点。
4. 获取该节点的 接入密钥 (Secret)。

2. 一键安装脚本

在节点服务器上运行：

curl -L https://raw.githubusercontent.com/Sagit-chu/flux-panel/main/install.sh -o install.sh && chmod +x install.sh && ./install.sh

安装过程中会提示输入：

• 服务器地址: 面板端的通信地址（通常是 http://<面板IP>:<后端端口>，例如 http://1.2.3.4:6365）。
• 密钥: 刚才在面板中获取的节点密钥。

或者直接使用带参数的命令（适用于自动化部署）：

# 替换 <面板地址> 和 <密钥>
./install.sh -a "http://1.2.3.4:6365" -s "your_node_secret"

3. 验证安装

安装完成后，服务会自动启动。

• 查看状态: systemctl status flux_agent
• 回到面板 节点管理 页面，该节点状态应显示为 在线。

---

三、Caddy 反向代理（可选）

如果需要通过域名访问面板并自动获取 HTTPS 证书，可以使用 Caddy 作为反向代理。

1. 安装 Caddy

# Debian / Ubuntu
sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https curl
curl -1sLf 'https://dl.cloudflare.com/content/v1/e2qwFJ2fRP2b2q/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg
curl -1sLf 'https://dl.cloudflare.com/content/v1/e2qwFJ2fRP2b2q/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list
sudo apt update
sudo apt install caddy

其他系统请参考 Caddy 官方安装文档。

2. 配置 Caddyfile

编辑 Caddy 配置文件：

sudo nano /etc/caddy/Caddyfile

面板域名配置

将 panel.example.com 替换为你自己的域名：

panel.example.com {
    reverse_proxy localhost:6366
}

Caddy 会自动为域名申请和续期 HTTPS 证书，无需额外配置。

3. 重启 Caddy

sudo systemctl restart caddy

4. 注意事项

• 确保域名已正确解析到服务器 IP。
• 确保服务器防火墙放行了 80 和 443 端口（Caddy 自动申请证书需要）。
• 使用 Caddy 反向代理后，可以在 .env 中将前端端口改为仅监听本地，避免直接暴露：

  FRONTEND_PORT=127.0.0.1:6366