iSrvd

名称源自 "it is a server daemon"，srv 对应 Linux 惯例目录 /srv，d 代表 daemon。发音：读作 "I served"（/ˈaɪ sɜːrvd/），谐音"爱服务"。

基于 Go + Vue 3 构建的轻量级运维面板，集成文件管理、Docker 容器编排、APISIX/Caddy 网关配置、Web 终端、GPU 监控、计划任务与 AI 助手，为个人服务器与中小型团队提供一站式管理体验。

提供三个镜像版本：

CNB 流水线会同步推送到 CNB Docker 制品库，镜像路径为 docker.cnb.cool/<repo-slug>:<tag>，支持 slim、caddy、apisix 三个标签，其中 slim 同时作为 latest。

首次启动自动生成随机密码，通过 docker logs isrvd 查看。

仅含 isrvd 本体，体积最小，适合只需要文件管理、Docker/Swarm/Compose、计划任务等功能的场景。

docker run -d \
  --name isrvd \
  -p 8080:8080 \
  -v /srv/data:/data \
  -v /var/run/docker.sock:/var/run/docker.sock \
  rehiy/isrvd:slim

isrvd + APISIX，适合已使用 APISIX 作为 API 网关的场景。

docker network create srvdnet
docker run -d \
  --name isrvd \
  --network srvdnet \
  -p 8080:8080 \
  -p 80:9080 \
  -p 443:9443 \
  -v /srv/data:/data \
  -v /var/run/docker.sock:/var/run/docker.sock \
  rehiy/isrvd:apisix

isrvd + Caddy，适合需要反向代理、自动 HTTPS（ACME）或统一网关管理的场景。

docker run -d \
  --name isrvd \
  -p 8080:8080 \
  -p 80:80 \
  -p 443:443 \
  -v /srv/data:/data \
  -v /var/run/docker.sock:/var/run/docker.sock \
  rehiy/isrvd:caddy

Caddy 默认配置仅监听 :80，关闭了自动 HTTPS 跳转，首次启动即可正常访问。如需 HTTPS，在「Caddy → 全局选项」中开启，或直接编辑「原始配置」。

services:
  isrvd:
    image: rehiy/isrvd:slim
    container_name: isrvd
    restart: unless-stopped
    ports:
      - "8080:8080"
    volumes:
      - /srv/data:/data
      - /var/run/docker.sock:/var/run/docker.sock

注意：请始终挂载整个 /data 目录，避免容器重建时数据丢失。

安装目录：/usr/local/isrvd/（包含二进制和配置文件）

# 一键安装
bash <(curl -sL https://jscdn.rehi.org/gh/rehiy/isrvd/build/script/isrvd.sh) install

# 更新/卸载/仅下载
bash <(curl -sL https://jscdn.rehi.org/gh/rehiy/isrvd/build/script/isrvd.sh) update
bash <(curl -sL https://jscdn.rehi.org/gh/rehiy/isrvd/build/script/isrvd.sh) uninstall
bash <(curl -sL https://jscdn.rehi.org/gh/rehiy/isrvd/build/script/isrvd.sh) download

也可直接运行 ./isrvd，通过 CONFIG_PATH 指定配置位置：

# 默认读取 ./config.yml
./isrvd

# 本地 YAML
CONFIG_PATH=/data/conf/isrvd.yml ./isrvd

# etcd（value 仍为 config.yml 同款 YAML）
etcdctl put /isrvd/config "$(cat /data/conf/isrvd.yml)"
CONFIG_PATH="etcd://user:pass@127.0.0.1:2379/isrvd/config?scheme=http&timeout=5s" ./isrvd

# etcd key 不存在时，用 fallback YAML 初始化并写入 etcd
CONFIG_PATH="etcd://127.0.0.1:2379/isrvd/config?fallback=/data/conf/isrvd.yml" ./isrvd

# etcd 完整配置示例
# etcd://user:pass@host1:2379,host2:2379/key?scheme=http&timeout=5s&fallback=/path/config.yml

etcd 认证可省略或用 ETCD_USERNAME / ETCD_PASSWORD 补充，配置变更仅记录重启提示，不自动热更新。

• Go：用于后端服务与命令行构建
• Node.js / npm：用于 webview 前端开发与构建
• Docker：可选，用于 Docker、Swarm、Compose 相关功能调试

./develop.sh

开发脚本会自动：

• 后端：复制 config.yml 为 .local.yml（如不存在），并通过 CONFIG_PATH=.local.yml go run cmd/server/main.go 启动
• 前端：进入 webview，安装依赖并执行 npm run dev
• 端口清理：启动前尝试释放 8080 和 3000 端口

Windows 环境可使用：

develop.bat

# 完整分发构建
./build.sh

# 后端测试
go test ./...

# 前端类型检查
cd webview && npm run lint

# 前端 import 排序检查
cd webview && python3 sort-imports.py --dry-run src

贡献代码前请优先阅读 AGENTS.md。该文件是当前仓库的代码规范与协作约定入口，旧版 CODE_STYLE 不再作为规范来源。

权限基于路由进行细粒度控制，每个用户可以独立授予各模块下具体 API 路由的访问权限。

权限格式：<METHOD> /api/<模块>/<路由>（如 GET /api/overview/status、POST /api/account/member）

前端权限判断：使用 actions.hasPerm('<METHOD> /api/<路由>') 控制按钮/操作的显示

常用模块与路由示例：

留空 = 无权限；具体可用路由见各模块 API 文档

支持自动检测 NVIDIA / AMD / Intel / Apple Silicon 独立显卡，显示使用率、显存、温度、功耗、风扇转速。

自动过滤虚拟显卡与核显（Intel Arc 独显保留）。

NVIDIA：

docker run -d --gpus all rehiy/isrvd:slim

AMD / Intel：

docker run -d --device /dev/dri:/dev/dri rehiy/isrvd:slim

config → registry → pkgs → service → server

• config：配置加载
• registry：外部服务初始化
• pkgs：各模块客户端（Docker / Swarm / APISIX / Caddy / GPU / Compose / Archive）
• service：业务逻辑与类型转换
• server：HTTP handlers

• 高内聚：同一领域功能聚合在同一包
• 低耦合：层间通过接口解耦
• 单一职责：Handler 只管 HTTP，Service 只管业务

• 后端分层：pkgs 保持原生客户端能力，service 负责业务组合与类型转换，server 只处理 HTTP 入出口
• 前端结构：webview/src/service/types 按域拆分类型，页面复用统一卡片、表格、移动端双视图和操作按钮语义色
• 状态与权限：全局状态通过 Provide/Inject 注入，权限统一使用 hasPerm(module, write?) 判断
• 安全基线：敏感字段不返回明文，文件路径与解压路径必须校验，WebSocket 必须经过认证链路
• 完整规范：详见 AGENTS.md

• JWT 认证，敏感字段（密钥、密码）不返回前端
• 文件路径校验，防止目录遍历攻击
• 解压校验路径，防止 Zip Slip 攻击
• WebSocket 连接需经过认证中间件
• 基于路由的细粒度权限控制，路由访问级别支持 0 需权限、1 需登录、-1 匿名
• 操作审计日志，路由审计级别支持 0 按 Method、-1 忽略、1 强制记录，默认记录非 GET 请求与 WebSocket 连接
• 支持代理认证头（proxyHeaderName）

本项目基于 Apache License 2.0 发布，详见 LICENSE。

第三方组件协议详见 NOTICE。