chore: auto registry runner to github

soulteary · soulteary · commit 5f01c12043b6 · 2026-02-17T13:47:44.000+08:00
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -0,0 +1,35 @@
+# 基于 docs/docker.md 中「方式二：DinD」编排
+# 使用前请确保 config.yaml 中 runners.base_path 为 /app/runners
+
+services:
+  runner-dind:
+    image: docker:dind
+    container_name: runner-dind
+    privileged: true
+    environment:
+      DOCKER_TLS_CERTDIR: ""
+    # 显式关闭 TLS，仅在内网 runner-net 使用，消除弃用告警
+    command: ["--tls=false"]
+    networks:
+      - runner-net
+    restart: unless-stopped
+
+  runner-manager:
+    image: ghcr.io/soulteary/runner-fleet:main
+    container_name: runner-manager
+    depends_on:
+      - runner-dind
+    environment:
+      DOCKER_HOST: tcp://runner-dind:2375
+    ports:
+      - "8080:8080"
+    volumes:
+      - ./config.yaml:/app/config.yaml
+      - ./runners:/app/runners
+    networks:
+      - runner-net
+    restart: unless-stopped
+
+networks:
+  runner-net:
+    driver: bridge
diff --git a/docs/adding-runner.md b/docs/adding-runner.md
@@ -16,6 +16,18 @@
 
 若与已有 Runner 同名，会提示不可重复。
 
+### 从 GitHub 命令一键填充
+
+在 GitHub 的「New self-hosted runner」页面会看到类似命令：
+
+```bash
+./config.sh --url https://github.com/owner/repo --token YOUR_TOKEN
+```
+
+在管理界面「快速添加 Runner」上方的**从 GitHub 复制命令解析**框中粘贴整行命令，点击「解析并填充」，会自动识别并填入**目标类型**、**目标**、**注册 Token**，并建议**名称**（仓库名或组织名），无需手动拆分 URL 与 Token。
+
+**说明**：自动注册（填写 Token 并提交）时，服务会向 **GitHub.com** 发起注册；若你使用的是 GitHub Enterprise，请勿在界面使用「自动注册」，需在对应 runner 目录下手动执行 `config.sh --url <你的 Enterprise URL> --token <TOKEN>`。
+
 在界面中**编辑**已有 Runner 的配置（目标、标签等）并保存后，若该 Runner 已注册且当前未在运行，也会**自动启动**，无需再手动点击「启动」。
 
 ## 3. Runner 程序未安装时
@@ -28,7 +40,7 @@
    ./config.sh --url https://github.com/owner/repo --token <TOKEN>
    ```
 
-**使用 Docker 或 DinD 时**：镜像内没有 runner 二进制，添加 Runner 时只会创建空目录。若希望提交表单时自动完成注册，可**在容器内执行安装脚本**（见 [Docker 部署](docker.md) 中「Docker/DinD 下自动注册的前提」）完成解压后再在界面添加；或先在宿主机把 runner 解压到挂载的 `runners/<名称>/` 下，再在界面填写并提交（名称、目标、Token）。若已先提交导致目录为空，请在该目录解压 runner 后，到 GitHub 重新获取 Token，在目录下手动执行上述 `config.sh`。
+**使用 Docker 或 DinD 时**：若在「快速添加」中填写了 Token 并提交，服务会**先自动执行安装脚本**（下载并解压 runner 到该目录），再执行注册并启动；无需事先手动执行 `install-runner.sh`。若自动安装失败（如网络问题），可按 [Docker 部署](docker.md) 中「Docker/DinD 下自动注册的前提」手动安装后，重新获取 Token 再在界面提交或在该目录下手动执行 `config.sh`。
 
 ## 一台机器多 Runner
 
diff --git a/docs/docker.md b/docs/docker.md
@@ -83,38 +83,26 @@ docker run -d --name runner-manager \
 - Runner 子进程会继承 `DOCKER_HOST`，Job 中的 `docker` 命令将使用 `runner-dind` 容器内的守护进程。
 - DinD 需 `--privileged`，且与宿主机 Docker 隔离，适合希望 Job 与宿主机环境隔离的场景。
 
-#### Docker/DinD 下「自动注册」的前提
+#### Docker/DinD 下「自动注册」
 
-本镜像**不包含** GitHub Actions runner 二进制。添加 Runner 时若在表单中填写了 Token，服务只会在**已存在 runner 程序的目录**里执行 `config.sh` 完成注册；若该目录为空（刚由服务创建），则只会保存配置并返回提示「请将 runner 解压到某目录后再次提交或手动执行 config.sh」。
+本镜像**不包含** GitHub Actions runner 二进制，但**支持在 Web 界面一次完成安装与注册**：在「快速添加 Runner」中填写名称、目标、Token 并提交后，服务会先自动执行 `/app/scripts/install-runner.sh` 下载并解压 runner，再执行 `config.sh` 向 GitHub 注册并启动 Runner。无需事先手动安装。
 
-因此在使用 Docker/DinD 时，若希望**一次提交就完成注册**，请按以下顺序操作：
+若自动安装失败（例如网络不可达 GitHub releases），可改为手动安装后再在界面提交 Token，或手动执行注册：
 
-1. **方式 A：容器内使用安装脚本**（推荐）  
-   在宿主机执行以下命令，会在挂载的 `runners/<名称>/` 下自动下载并解压 runner（默认版本 2.331.0，可选校验哈希）：
+1. **容器内执行安装脚本**（推荐）  
    ```bash
    docker exec runner-manager /app/scripts/install-runner.sh <名称> [版本号]
    ```
-   若 `config.yaml` 中 `runners.base_path` 不是 `/app/runners`，可设置环境变量后执行，例如：
+   若 `config.yaml` 中 `runners.base_path` 不是 `/app/runners`，可设置环境变量：
    ```bash
    docker exec -e RUNNERS_BASE_PATH=/app/runners runner-manager /app/scripts/install-runner.sh my-runner
    ```
+2. **或在宿主机**创建 `runners/<名称>/` 并解压 [actions-runner Linux 包](https://github.com/actions/runner/releases)，再在界面填写名称、目标、Token 提交。
 
-2. **方式 B：在宿主机**（挂载 `runners` 的那台机器）上，先创建对应子目录并解压 runner：
-   ```bash
-   mkdir -p runners/<名称>
-   cd runners/<名称>
-   # 从 https://github.com/actions/runner/releases 下载 Linux x64 包并解压到当前目录
-   curl -sL https://github.com/actions/runner/releases/download/v2.321.0/actions-runner-linux-x64-2.321.0.tar.gz | tar xz
-   ```
-3. 再在管理界面「快速添加 Runner」中填写名称（与上面使用的 `<名称>` 一致）、目标、Token 并提交，此时服务会检测到 `config.sh` 并自动执行注册。
-
-若已先在界面添加了 Runner（目录已创建但为空），可：
-
-- 在宿主机进入 `runners/<名称>/`，解压 runner 后，到 GitHub 重新获取一份 Token，在该目录下手动执行：
+若已先在界面添加了 Runner（目录已创建但为空），可删除该 Runner 后重新在界面填写 Token 提交（会触发自动安装），或在目录内解压 runner 后到 GitHub 重新获取 Token，手动执行：
   ```bash
   ./config.sh --url https://github.com/<目标> --token <新TOKEN>
   ```
-- 或删除该 Runner 配置后，按上面 1/2→3 顺序重新添加（可改用方式 A 在容器内执行安装脚本）。
 
 ---
 
diff --git a/internal/handler/handler.go b/internal/handler/handler.go
@@ -1,18 +1,23 @@
 package handler
 
 import (
+	"context"
 	"crypto/rand"
 	"net/http"
 	"os"
 	"os/exec"
 	"path/filepath"
 	"strings"
+	"time"
 
 	"github.com/lab-dev/github-actions-runner-manager/internal/config"
 	"github.com/lab-dev/github-actions-runner-manager/internal/runner"
 	"github.com/labstack/echo/v4"
 )
 
+// installRunnerScriptPath 容器内自动安装 runner 的脚本路径（Docker 镜像中有）
+const installRunnerScriptPath = "/app/scripts/install-runner.sh"
+
 // ConfigPath 配置文件路径，由 main 注入
 var ConfigPath string
 
@@ -48,6 +53,19 @@ func runnerNameExists(cfg *config.Config, name string) bool {
 	return false
 }
 
+// runInstallRunnerScript 执行容器内 install-runner.sh，下载并解压 runner 到 basePath/runnerName；超时返回 error
+func runInstallRunnerScript(basePath, runnerName string, timeout time.Duration) ([]byte, error) {
+	ctx, cancel := context.WithTimeout(context.Background(), timeout)
+	defer cancel()
+	cmd := exec.CommandContext(ctx, installRunnerScriptPath, runnerName)
+	cmd.Env = append(os.Environ(), "RUNNERS_BASE_PATH="+basePath)
+	out, err := cmd.CombinedOutput()
+	if ctx.Err() == context.DeadlineExceeded {
+		return out, context.DeadlineExceeded
+	}
+	return out, err
+}
+
 // Health 健康检查，供负载均衡或 K8s 探针使用
 func Health(c echo.Context) error {
 	return c.JSON(http.StatusOK, map[string]string{"status": "ok"})
@@ -151,11 +169,35 @@ func AddRunner(c echo.Context) error {
 		// 在 installDir 执行 config 脚本
 		configScript := filepath.Join(installDir, runner.ConfigScriptName())
 		if _, err := os.Stat(configScript); err != nil {
-			return c.JSON(http.StatusOK, map[string]any{
-				"message":     "配置已保存，Runner 目录已创建。请将 GitHub Actions runner 解压到 " + installDir + " 后，使用注册 token 再次提交或在该目录下手动执行 " + runner.ConfigScriptName(),
-				"name":        item.Name,
-				"install_dir": installDir,
-			})
+			// 目录为空时（如 Docker 部署）：若存在自动安装脚本则先安装 runner 再注册
+			if _, scriptErr := os.Stat(installRunnerScriptPath); scriptErr == nil {
+				runnerSegment := filepath.Base(installDir)
+				installOut, installErr := runInstallRunnerScript(cfg.Runners.BasePath, runnerSegment, 3*time.Minute)
+				if installErr != nil {
+					return c.JSON(http.StatusOK, map[string]any{
+						"message":     "配置已保存，自动安装 Runner 失败（请检查网络或稍后手动安装）: " + installErr.Error(),
+						"name":        item.Name,
+						"install_dir": installDir,
+						"output":      string(installOut),
+					})
+				}
+				// 安装后再次检查 config 脚本
+				if _, err2 := os.Stat(configScript); err2 != nil {
+					return c.JSON(http.StatusOK, map[string]any{
+						"message":     "配置已保存，Runner 已安装但未找到 " + runner.ConfigScriptName() + "，请检查 " + installDir,
+						"name":        item.Name,
+						"install_dir": installDir,
+						"output":      string(installOut),
+					})
+				}
+				// 继续执行下方的 config 与启动逻辑
+			} else {
+				return c.JSON(http.StatusOK, map[string]any{
+					"message":     "配置已保存，Runner 目录已创建。请将 GitHub Actions runner 解压到 " + installDir + " 后，使用注册 token 再次提交或在该目录下手动执行 " + runner.ConfigScriptName(),
+					"name":        item.Name,
+					"install_dir": installDir,
+				})
+			}
 		}
 		url := "https://github.com/" + req.Target
 		cmd := exec.Command(configScript, "--url", url, "--token", req.RegistrationToken)
@@ -192,29 +234,6 @@ func AddRunner(c echo.Context) error {
 	})
 }
 
-// RemoveRunnerRequest 删除 runner 请求（仅从配置移除，不执行 remove-token）
-type RemoveRunnerRequest struct {
-	Name string `json:"name" form:"name"`
-}
-
-// RemoveRunner 从配置中移除 runner（POST body 或 form 提供 name）
-func RemoveRunner(c echo.Context) error {
-	var req RemoveRunnerRequest
-	_ = c.Bind(&req)
-	if req.Name == "" {
-		return echo.NewHTTPError(http.StatusBadRequest, "请提供 name")
-	}
-	if err := config.LoadAndSave(ConfigPath, func(cfg *config.Config) error {
-		return removeRunnerFromConfig(cfg, req.Name)
-	}); err != nil {
-		if he, ok := err.(*echo.HTTPError); ok {
-			return he
-		}
-		return echo.NewHTTPError(http.StatusInternalServerError, "保存配置失败")
-	}
-	return c.JSON(http.StatusOK, map[string]any{"message": "已从配置中移除"})
-}
-
 // GetRunner 查看单个 runner 配置与状态（GET /api/runners/:name）
 func GetRunner(c echo.Context) error {
 	cfg, err := getConfig(c)
diff --git a/internal/runner/runner.go b/internal/runner/runner.go
@@ -159,7 +159,8 @@ func RunScriptName() string {
 	return "run.sh"
 }
 
-// readRunnerPid 读取 runner 的 pid 文件（Runner.Listener.pid 或 .path），返回 pid，无效则 0 与 error
+// readRunnerPid 读取 runner 的 pid 文件，返回 pid，无效则 0 与 error。
+// Runner.Listener.pid 为官方 runner 使用；.path 为部分版本或兼容用途。
 func readRunnerPid(installDir string) (int, error) {
 	for _, name := range []string{"Runner.Listener.pid", ".path"} {
 		f := filepath.Join(installDir, name)
diff --git a/templates/index.html b/templates/index.html
@@ -124,6 +124,40 @@
     .msg.ok { background: rgba(63, 185, 80, 0.15); color: var(--success); }
     .msg.err { background: rgba(248, 81, 73, 0.15); color: var(--danger); }
     .path { font-family: ui-monospace, monospace; font-size: 12px; color: var(--muted); }
+    .parse-box {
+      margin-bottom: 20px;
+      padding-bottom: 20px;
+      border-bottom: 1px solid var(--border);
+    }
+    .parse-box label { display: block; margin-bottom: 8px; color: var(--muted); font-size: 13px; }
+    .parse-box code { background: var(--bg); padding: 2px 6px; border-radius: 4px; font-size: 12px; }
+    .parse-row { display: flex; gap: 12px; align-items: flex-start; flex-wrap: wrap; }
+    .parse-row textarea {
+      flex: 1;
+      min-width: 280px;
+      padding: 10px 12px;
+      background: var(--bg);
+      border: 1px solid var(--border);
+      border-radius: 6px;
+      color: var(--text);
+      font-family: ui-monospace, monospace;
+      font-size: 13px;
+      resize: vertical;
+    }
+    .btn-parse {
+      padding: 10px 16px;
+      background: var(--accent);
+      color: var(--bg);
+      border: none;
+      border-radius: 6px;
+      cursor: pointer;
+      font-weight: 600;
+      white-space: nowrap;
+    }
+    .btn-parse:hover { opacity: 0.9; }
+    .parse-msg { margin-top: 8px; font-size: 13px; }
+    .parse-msg.ok { color: var(--success); }
+    .parse-msg.err { color: var(--danger); }
   </style>
 </head>
 <body>
@@ -169,22 +203,30 @@ <h2>Runner 列表</h2>
 
   <div class="card">
     <h2>快速添加 Runner</h2>
+    <div class="parse-box">
+      <label>从 GitHub 复制命令解析（粘贴 <code>./config.sh --url ... --token ...</code> 后点击解析）</label>
+      <div class="parse-row">
+        <textarea id="githubCommandInput" rows="3" placeholder="./config.sh --url https://github.com/owner/repo --token YOUR_TOKEN"></textarea>
+        <button type="button" id="parseCommandBtn" class="btn-parse">解析并填充</button>
+      </div>
+      <div id="parseMsg" class="parse-msg"></div>
+    </div>
     <form id="addForm">
       <label>名称 (name) *</label>
-      <input name="name" required placeholder="例如 runner-1">
+      <input name="name" id="addFormName" required placeholder="例如 runner-1">
       <label>子路径 (path，可选，默认用名称)</label>
-      <input name="path" placeholder="例如 runner-1">
+      <input name="path" id="addFormPath" placeholder="例如 runner-1">
       <label>目标类型 (target_type) *</label>
-      <select name="target_type" required>
+      <select name="target_type" id="addFormTargetType" required>
         <option value="org">组织 (org)</option>
         <option value="repo">仓库 (repo)</option>
       </select>
       <label>目标 (target) *</label>
-      <input name="target" required placeholder="组织名 或 owner/repo">
+      <input name="target" id="addFormTarget" required placeholder="组织名 或 owner/repo">
       <label>标签 (labels，逗号分隔，可选)</label>
-      <input name="labelsStr" placeholder="self-hosted, linux, x64">
+      <input name="labelsStr" id="addFormLabelsStr" placeholder="self-hosted, linux, x64">
       <label>注册 Token（可选，从 GitHub 设置 → Actions → Runners 复制，1 小时有效）</label>
-      <input name="registration_token" type="password" placeholder="选填，有则自动执行注册">
+      <input name="registration_token" id="addFormToken" type="password" placeholder="选填；填写后将自动安装（Docker 下）并注册、启动">
       <button type="submit">添加 Runner</button>
     </form>
     <div id="addMsg"></div>
@@ -229,6 +271,74 @@ <h3 id="modalTitle">Runner 配置</h3>
   </div>
 
   <script>
+    // 解析 GitHub config.sh 命令，填充到添加 Runner 表单
+    // 与后端 isValidNameOrPath 一致：不允许含 .. / \
+    function sanitizeRunnerName(s) {
+      if (!s || typeof s !== 'string') return '';
+      return s.replace(/\.\./g, '').replace(/[/\\]/g, '-').trim() || 'runner';
+    }
+
+    function parseGitHubConfigCommand(text) {
+      if (!text || typeof text !== 'string') return { ok: false, message: '请输入命令' };
+      const trimmed = text.trim();
+      // 匹配 --url <URL> 和 --token <TOKEN>（兼容多余空格、换行、引号）
+      const urlMatch = trimmed.match(/\-\-url\s+["']?([^\s"']+)["']?/);
+      const tokenMatch = trimmed.match(/\-\-token\s+["']?([^\s"']+)["']?/);
+      if (!urlMatch) return { ok: false, message: '未找到 --url 参数' };
+      const url = urlMatch[1].trim();
+      let parsedUrl;
+      try {
+        parsedUrl = new URL(url);
+      } catch (e) {
+        return { ok: false, message: 'URL 格式无效' };
+      }
+      // pathname 不含 query/hash，支持 GitHub 与 GitHub Enterprise
+      const pathParts = parsedUrl.pathname.replace(/^\/+|\/+$/g, '').split('/').filter(Boolean);
+      let targetType = 'org';
+      let target = '';
+      let suggestedName = '';
+      if (pathParts.length >= 2) {
+        targetType = 'repo';
+        target = pathParts[0] + '/' + pathParts[1];
+        suggestedName = sanitizeRunnerName(pathParts[1]);
+      } else if (pathParts.length === 1) {
+        target = pathParts[0];
+        suggestedName = sanitizeRunnerName(pathParts[0]);
+      } else {
+        return { ok: false, message: '无法从 URL 解析出组织或仓库' };
+      }
+      const token = tokenMatch ? tokenMatch[1].trim() : '';
+      return {
+        ok: true,
+        target_type: targetType,
+        target: target,
+        registration_token: token,
+        suggested_name: suggestedName || 'runner'
+      };
+    }
+
+    document.getElementById('parseCommandBtn').addEventListener('click', function() {
+      const input = document.getElementById('githubCommandInput');
+      const msgEl = document.getElementById('parseMsg');
+      const result = parseGitHubConfigCommand(input.value);
+      msgEl.textContent = '';
+      msgEl.className = 'parse-msg';
+      if (!result.ok) {
+        msgEl.className = 'parse-msg err';
+        msgEl.textContent = result.message;
+        return;
+      }
+      document.getElementById('addFormTargetType').value = result.target_type;
+      document.getElementById('addFormTarget').value = result.target;
+      document.getElementById('addFormToken').value = result.registration_token || '';
+      if (result.suggested_name && !document.getElementById('addFormName').value) {
+        document.getElementById('addFormName').value = result.suggested_name;
+        document.getElementById('addFormPath').value = '';
+      }
+      msgEl.className = 'parse-msg ok';
+      msgEl.textContent = '已填充：目标类型 ' + result.target_type + '，目标 ' + result.target + (result.registration_token ? '，Token 已填入' : '');
+    });
+
     document.getElementById('addForm').addEventListener('submit', async (e) => {
       e.preventDefault();
       const fd = new FormData(e.target);

Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,8 @@ func RunScriptName() string {`
`159`	`159`	`return "run.sh"`
`160`	`160`	`}`
`161`	`161`
`162`		`-// readRunnerPid 读取 runner 的 pid 文件（Runner.Listener.pid 或 .path），返回 pid，无效则 0 与 error`
	`162`	`+// readRunnerPid 读取 runner 的 pid 文件，返回 pid，无效则 0 与 error。`
	`163`	`+// Runner.Listener.pid 为官方 runner 使用；.path 为部分版本或兼容用途。`
`163`	`164`	`func readRunnerPid(installDir string) (int, error) {`
`164`	`165`	`for _, name := range []string{"Runner.Listener.pid", ".path"} {`
`165`	`166`	`f := filepath.Join(installDir, name)`