ragflow-runbook
v0.1.4End-to-end runbook for deploying, operating, troubleshooting, and monitoring RAGFlow (runtime ops only).
⭐ 0· 261·1 current·1 all-time
byYITING OU@yitingou
MIT-0
Download zip
LicenseMIT-0 · Free to use, modify, and redistribute. No attribution required.
Security Scan
OpenClaw
Benign
high confidencePurpose & 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.
Assessment
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.Like a lobster shell, security has layers — review code before you run it.
latestvk974801e0zjhjgc68br522rysx82654n
License
MIT-0
Free to use, modify, and redistribute. No attribution required.
Runtime requirements
Binspython3, docker, curl