文档更新
This commit is contained in:
+86
-43
@@ -1,16 +1,21 @@
|
||||
## 🐳 Docker 版安装指南
|
||||
|
||||
> 推荐方式：一键脚本自动部署，无需手动编译，无需安装 Go 环境。</br>
|
||||
> 推荐方式：一键脚本自动部署，无需手动安装 Go 环境，无需预先配置 Docker 镜像源。
|
||||
|
||||
> ⚠️ **注意**：Docker 版直接从源码构建，使用的是当前 `main` 分支的最新代码，更新进度会远快于 Release 版本。⚠️</br>
|
||||
> 如需使用特定版本（如 LTS），请查看 [Releases](https://git.whitetop.xyz/lxh2875931338/frpc-console/releases) 确认版本号，并通过二进制方式部署指定版本。
|
||||
> ⚠️ **注意**：Docker 版直接从源码构建，使用的是当前所选分支（LTS / Preview）的最新代码。如需使用特定 Release 版本，请查看 [Releases](https://git.whitetop.xyz/lxh2875931338/frpc-console/releases) 并通过二进制方式部署。
|
||||
|
||||
---
|
||||
|
||||
### 一、📥 前置条件
|
||||
|
||||
- 已安装 Docker（必须）
|
||||
- 已安装 curl / wget（脚本会自动检查并安装）
|
||||
- 操作系统：Linux（x86_64 / ARM64 / ARMv7 均可）
|
||||
- **已安装 Docker**（必须，版本不限）
|
||||
- **curl**（其余依赖脚本会自动检查并安装）
|
||||
- **操作系统**：Linux（x86_64 / ARM64 / ARMv7 / ARMHF 均可）
|
||||
- **网络**：需能访问 Gitea 仓库（git.whitetop.xyz）
|
||||
|
||||
> 💡 脚本会自动检测并配置 Docker 镜像加速，无需手动设置。
|
||||
|
||||
---
|
||||
|
||||
### 二、🚀 一键部署（推荐）
|
||||
|
||||
@@ -20,54 +25,74 @@
|
||||
curl -sSL https://git.whitetop.xyz/lxh2875931338/frpc-console/raw/main/run-deploy.sh | sudo bash
|
||||
```
|
||||
|
||||
或手动下载执行：（举例为 LTS ）
|
||||
部署过程中会提示选择通道：
|
||||
|
||||
```bash
|
||||
wget https://git.whitetop.xyz/lxh2875931338/frpc-console/raw/main/deploy.sh
|
||||
chmod +x deploy.sh
|
||||
sudo bash deploy.sh
|
||||
```
|
||||
· LTS（稳定版） → main 分支，生产环境推荐
|
||||
· Preview（技术预览版） → test 分支，尝鲜和新特性验证
|
||||
|
||||
脚本会完整执行整个部署流程，包括镜像源自动检测与配置。
|
||||
|
||||
### 三、⚙️ 脚本自动完成内容
|
||||
---
|
||||
|
||||
| 步骤 | 说明 |
|
||||
|---|---|
|
||||
| 检测系统 | 自动识别 OpenSUSE（猫猫特有的夹带私货） / Ubuntu / Debian / CentOS / Alpine |
|
||||
| 检测 CPU 架构 | 自动适配 x86_64 / ARM64 / ARMv7 |
|
||||
| 安装依赖 | git / curl / wget（如未安装） |
|
||||
| 安装 Go | 从国内镜像下载，自动配置代理 |
|
||||
| 拉取源码 | 从 Gitea 仓库克隆最新代码 |
|
||||
| 编译二进制 | 根据当前架构编译 Linux 版 |
|
||||
| 构建 Docker 镜像 | 使用源码中的 Dockerfile 构建 |
|
||||
| 启动容器 | 挂载数据卷，开机自启 |
|
||||
三、⚙️ 部署引擎自动完成内容
|
||||
|
||||
deploy.sh 是一个完整的状态机驱动部署引擎，按时间顺序执行以下操作：
|
||||
|
||||
### 四、📂 数据持久化
|
||||
阶段 步骤 说明
|
||||
检测 检测操作系统 自动识别 openSUSE / Ubuntu / Debian / CentOS / Alpine / Arch
|
||||
检测 检测 CPU 架构 自动适配 x86_64 / ARM64 / ARMv7 / ARMHF
|
||||
检测 检测必要工具 git / curl / wget（如未安装则自动安装）
|
||||
检测 检测 Docker 环境 确认 Docker 已安装，获取版本信息
|
||||
检测 检测镜像源配置 读取 /etc/docker/daemon.json，检测用户配置和默认地址连通性
|
||||
决策 状态机计算 根据检测结果决定：是否写入镜像源 / 是否重排 / 是否重启 Docker
|
||||
决策 生成部署计划 展示完整操作清单，等待用户确认
|
||||
执行 拉取源码 从 Gitea 仓库克隆对应分支的最新代码
|
||||
执行 配置镜像源 按需写入 registry-mirrors，自动备份非法/空配置文件
|
||||
执行 重启 Docker 如需生效，自动重启 Docker 服务（交互模式需确认）
|
||||
执行 构建镜像 使用源码中的 Dockerfile 构建 frpc-console:${VERSION}
|
||||
执行 清理旧容器 检测并删除已存在的 frpc-console 容器（如有）
|
||||
执行 启动容器 挂载数据卷，--restart=always，--network host
|
||||
执行 写入版本 将版本号写入 data/version.ini
|
||||
验证 验证镜像内容 确认 /app/frpc-console 存在
|
||||
验证 验证数据库 确认 SQLite 数据库可访问
|
||||
验证 验证版本 确认容器内版本与目标版本一致
|
||||
清理 清理旧镜像 保留最近 3 个镜像，自动删除更早版本
|
||||
清理 清理临时文件 删除 /tmp/frpc-console-build
|
||||
|
||||
脚本默认将数据存储在 `/opt/frpc-console/data/`：
|
||||
---
|
||||
|
||||
| 文件 | 说明 |
|
||||
|---|---|
|
||||
| `frpc-console.db` | SQLite 数据库（用户、隧道、配置） |
|
||||
| `frpc.toml` | 生成的 frpc 配置文件 |
|
||||
| `frpc.log` | frpc 运行日志 |
|
||||
| `frpc.pid` | frpc 进程 PID |
|
||||
四、📂 数据持久化
|
||||
|
||||
脚本默认将数据存储在 /opt/frpc-console/data/：
|
||||
|
||||
文件 说明
|
||||
frpc-console.db SQLite 数据库（用户、隧道、配置）
|
||||
frpc.toml 当前 frpc 配置文件
|
||||
frpc.log frpc 运行日志
|
||||
frpc.pid frpc 进程 PID
|
||||
version.ini 当前版本标识
|
||||
|
||||
升级或重建容器时，数据自动保留，不会丢失。
|
||||
|
||||
---
|
||||
|
||||
### 五、🔄 升级
|
||||
五、🔄 升级
|
||||
|
||||
**方式一：重新运行脚本**
|
||||
方式一：重新运行部署脚本（推荐）
|
||||
|
||||
```bash
|
||||
sudo bash deploy.sh
|
||||
curl -sSL https://git.whitetop.xyz/lxh2875931338/frpc-console/raw/main/run-deploy.sh | sudo bash
|
||||
```
|
||||
|
||||
脚本会自动停止旧容器、拉取最新代码、重新编译并启动新容器，数据卷保持不变。
|
||||
脚本会自动：
|
||||
|
||||
**方式二：手动更新**
|
||||
1. 拉取最新代码
|
||||
2. 构建新镜像
|
||||
3. 停止并删除旧容器
|
||||
4. 启动新容器
|
||||
5. 数据卷保持不变
|
||||
|
||||
方式二：手动更新
|
||||
|
||||
```bash
|
||||
# 停止旧容器
|
||||
@@ -75,11 +100,14 @@ docker stop frpc-console
|
||||
docker rm frpc-console
|
||||
|
||||
# 重新运行 deploy.sh
|
||||
sudo bash deploy.sh
|
||||
curl -sSL https://git.whitetop.xyz/lxh2875931338/frpc-console/raw/main/run-deploy.sh | sudo bash
|
||||
```
|
||||
|
||||
💡 升级时如检测到语义版本降级（如 2.6 → 2.5），脚本会自动备份数据目录，并等待用户确认后再执行。
|
||||
|
||||
### 六、🧹 常用命令
|
||||
---
|
||||
|
||||
六、🧹 常用命令
|
||||
|
||||
```bash
|
||||
# 查看日志
|
||||
@@ -96,10 +124,14 @@ docker stop frpc-console
|
||||
|
||||
# 启动容器
|
||||
docker start frpc-console
|
||||
|
||||
# 查看当前版本
|
||||
cat /opt/frpc-console/data/version.ini
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 七、🌐 访问地址
|
||||
七、🌐 访问地址
|
||||
|
||||
部署完成后，浏览器打开：
|
||||
|
||||
@@ -109,12 +141,13 @@ http://你的服务器IP:9300
|
||||
|
||||
首次访问会自动跳转到注册页面，填写用户名和密码，完成管理员账户创建。
|
||||
|
||||
登录后，在「隧道列表」页面点击「导入 TOML」，即可将现有的 `frpc.toml` 迁移到 WebUI 中管理。
|
||||
登录后，在「隧道列表」页面点击「导入 TOML」，即可将现有的 frpc.toml 迁移到 WebUI 中管理。
|
||||
|
||||
---
|
||||
|
||||
### 八、📌 手动部署（不使用脚本）
|
||||
八、📌 手动部署（不使用脚本）
|
||||
|
||||
如果你已有源码，或想自行定制：
|
||||
如果你已有源码，或想完全手动控制：
|
||||
|
||||
```bash
|
||||
# 1. 克隆代码
|
||||
@@ -132,8 +165,18 @@ docker run -d \
|
||||
--name frpc-console \
|
||||
--restart=always \
|
||||
--network host \
|
||||
-v /opt/frpc-console/data:/app\
|
||||
-v /opt/frpc-console/data:/app/data \
|
||||
-e PORT=9300 \
|
||||
-e TZ=Asia/Shanghai \
|
||||
frpc-console:latest
|
||||
```
|
||||
|
||||
⚠️ 手动部署不会自动处理镜像源配置、版本管理、容器冲突检测和镜像清理。建议优先使用一键部署脚本。
|
||||
|
||||
---
|
||||
|
||||
九、📖 相关文档
|
||||
|
||||
· 部署引擎设计详解 — 了解 deploy.sh 的状态机设计与工程决策
|
||||
· 工程设计哲学 — 理解部署脚本背后的设计理念
|
||||
· 二进制安装指南 — 适用于无 Docker 或边缘设备场景
|
||||
Reference in New Issue
Block a user