← Back to Skills Marketplace
318
Downloads
0
Stars
1
Active Installs
5
Versions
Install in OpenClaw
/install ragflow-runbook
Description
End-to-end runbook for deploying, operating, troubleshooting, and monitoring RAGFlow (runtime ops only).
Usage Guidance
This skill appears to do what it says: an ops runbook for RAGFlow. Before installing/using it: 1) Keep your RAGFLOW_API_KEY secret (export it in your shell or a secrets manager; do not paste into chat). 2) Inspect scripts (especially deploy.sh) before running; the fallback download path fetches files from raw.githubusercontent.com but only if you set RAGFLOW_RUNBOOK_ALLOW_DOWNLOAD=1. 3) Starting containers is disabled by default; set RAGFLOW_RUNBOOK_ALLOW_START=1 only when you intend to run docker compose up. 4) The alert helper calls the openclaw CLI and requires an OpenClaw chat target if used — install/configure OpenClaw first or avoid alerting. 5) If you need extra assurance, run these scripts in an isolated/test environment (not production) the first time. The only minor inconsistency is that registry metadata declared no required env vars while SKILL.md does — this is documented in the changelog as an intentional duplication for scanners and does not materially change the skill's behavior.
Capability Analysis
Type: OpenClaw Skill
Name: ragflow-runbook
Version: 0.1.4
The skill bundle is designed for RAGFlow runtime operations, including deployment, health checks, and alerting. All scripts and documentation align with this stated purpose. Notably, `scripts/deploy.sh` includes explicit opt-in mechanisms (`RAGFLOW_RUNBOOK_ALLOW_DOWNLOAD`, `RAGFLOW_RUNBOOK_ALLOW_START`) to prevent unauthorized downloading of upstream files or starting containers, which is a strong security safeguard. The `SKILL.md` and other documentation provide clear instructions and security warnings (e.g., regarding API key handling and default passwords), without any evidence of prompt injection attempts to manipulate the agent maliciously. Python scripts (`ragflow_ping.py`, `ragflow_smoke.py`, `ragflow_status.py`) perform standard API calls for health monitoring, and `ragflow_alert.py` uses the `openclaw message send` CLI for intended operational alerts, explicitly warning against including secrets. There is no evidence of data exfiltration, unauthorized persistence, or malicious execution.
Capability Assessment
Purpose & Capability
Name/description (RAGFlow runtime ops) matches the included scripts and runtime instructions. Requested binaries (python3, docker, curl) and optional git/openclaw are appropriate for deploying, checking, and alerting RAGFlow. No unrelated cloud credentials or surprising tools are requested.
Instruction Scope
SKILL.md and the scripts focus on liveness/readiness, status, smoke tests, and deploy helpers. They require RAGFLOW_BASE_URL and optionally RAGFLOW_API_KEY/OPENCLAW_PRIMARY_CHAT_ID. The runbook explicitly warns not to paste secrets in chat and the scripts avoid reading arbitrary local secret files. The deploy script will download upstream docker files only if the operator opt-ins via env flags, which is appropriate for a deploy tool.
Install Mechanism
There is no formal install spec (instruction-only), which is low risk. The included deploy.sh has a fallback that downloads raw files from GitHub (raw.githubusercontent.com) when git is not available; that pattern is expected for a deploy helper but still carries the usual risk of fetching remote code — the script requires an explicit opt-in (RAGFLOW_RUNBOOK_ALLOW_DOWNLOAD) before downloading files, which mitigates accidental execution.
Credentials
Required/optional env vars are proportional and specific to the task (RAGFLOW_BASE_URL required in SKILL.md; RAGFLOW_API_KEY and OPENCLAW_PRIMARY_CHAT_ID optional). The skill does not request unrelated credentials. Note: registry metadata provided at the top-level listed 'none' for required env vars, but the SKILL.md front matter declares RAGFLOW_BASE_URL as required — this duplication was intentional (per CHANGELOG) for scanner compatibility but is a minor metadata inconsistency rather than a functional issue.
Persistence & Privilege
The skill does not request always:true and is user-invocable. It does not modify other skills or system-wide configs. Deploy operations write to a user-specified deploy root (default ./ragflow) and require explicit opt-in before starting containers (RAGFLOW_RUNBOOK_ALLOW_START), which is appropriate for an ops tool.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install ragflow-runbook - After installation, invoke the skill by name or use
/ragflow-runbook - Provide required inputs per the skill's parameter spec and get structured output
Version History
v0.1.4
Deploy safety: deploy.sh now requires explicit opt-in for runtime downloads and starting containers.
v0.1.3
Metadata compatibility: duplicate env declarations at top-level and metadata.env so scanners display required env vars.
v0.1.2
Metadata: make required env vars parseable + declare optional openclaw dependency for alerting.
v0.1.1
Security: ragflow_alert.py no longer defaults to a hardcoded Telegram target and no longer includes base URL. Metadata: declare required env vars.
v0.1.0
Initial release: RAGFlow runtime ops runbook + built-in deploy/healthcheck/ping/smoke/status/alert scripts + cron/launchd templates.
Metadata
Frequently Asked Questions
What is ragflow-runbook?
End-to-end runbook for deploying, operating, troubleshooting, and monitoring RAGFlow (runtime ops only). It is an AI Agent Skill for Claude Code / OpenClaw, with 318 downloads so far.
How do I install ragflow-runbook?
Run "/install ragflow-runbook" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is ragflow-runbook free?
Yes, ragflow-runbook is completely free (open-source). You can download, install and use it at no cost.
Which platforms does ragflow-runbook support?
ragflow-runbook is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created ragflow-runbook?
It is built and maintained by YITING OU (@yitingou); the current version is v0.1.4.
More Skills