Homelab Runbook

面向 macOS/Linux 主机的服务清点 Skill：用 scripts 下的 Python 脚本采集 Docker 容器、launchd/systemd 系统服务和开放 TCP 端口，再由 generate_runbook.py 汇总成 Markdown runbook，可打印或写入文件，也支持先采集 JSON 再合并与定时执行。Docker 缺失或权限不足时输出警告并继续。

newageinvestments25-byte

热度 45.96

最近更新 2026-05-11 17:38:19

分类：自动化依赖：代码执行 / 读写文件应用场景：DevOps / 自动化脚本 / 报告撰写 / 工作流

安装技能

复制下面的话术发给你的 Agent，它会通过 secure-skills 检索并安装该技能。

执行命令安装此 skill： npx secure-skills-cli add homelab-runbook

Metadata

name: homelab-runbook
description: Scan and document all running services on this machine — Docker containers, system services (launchd/systemd), and open listening ports. Generates a human-readable Markdown runbook with service names, ports, images, mount points, and health status. Use when the user asks about homelab, runbook, document services, what's running, service inventory, homelab docs, list my services, scan ports, or wants a snapshot of what's active on the host machine. Can run on demand or on a cron schedule. Works on macOS and Linux.

Homelab Runbook

Scan the host machine and generate a Markdown runbook documenting all running services.

Scripts

All scripts are in scripts/. Run with python3 <script>. All output JSON to stdout.

Script	Purpose
`scan_docker.py`	Running containers: name, image, ports, mounts, status
`scan_services.py`	System services via launchd (macOS) or systemd (Linux)
`scan_ports.py`	Open TCP listening ports with process and PID
`generate_runbook.py`	Combine all scans → formatted Markdown runbook

Generating a Runbook

Quickest — run all scanners inline and print to stdout:

python3 scripts/generate_runbook.py

Save to a file:

python3 scripts/generate_runbook.py --output ~/homelab-runbook.md

Save to workspace:

python3 scripts/generate_runbook.py --output /Users/openclaw/.openclaw/workspace/homelab-runbook.md

Pre-collect then generate (useful for cron or piping):

python3 scripts/scan_docker.py > /tmp/docker.json
python3 scripts/scan_services.py > /tmp/services.json
python3 scripts/scan_ports.py > /tmp/ports.json
python3 scripts/generate_runbook.py --docker /tmp/docker.json --services /tmp/services.json --ports /tmp/ports.json --output ~/homelab-runbook.md

Agent Workflow

When the user asks for a homelab runbook or service inventory:

Run generate_runbook.py (all scanners inline, save to workspace file).
Read the output file and summarize key findings:
- How many Docker containers are running and what they are
- Notable open ports and the processes owning them
- Any errors or warnings (Docker not found, permission denied, etc.)
Offer to save to Obsidian vault if the user wants it persisted.

Use the --output flag to write to the workspace. Do not dump the full raw Markdown at the user — summarize it and offer the file path.

Edge Cases

Docker not installed: scan_docker.py returns {"error": "Docker not installed or not running", "containers": []} — runbook shows a warning, continues.
No containers running: Returns empty list, runbook shows "No running containers."
Port scan permission denied: scan_ports.py returns an error — runbook shows warning. Tell the user to re-run with sudo if full port visibility is needed.
Linux without systemd: scan_services.py will return an error — acceptable, runbook notes it.

Customization

See references/customization.md for:

Excluding specific services/containers/ports
Adding manual service notes (URLs, config paths, restart commands)
Scheduling with cron
Modifying output format