Helpifyr Spool Compatibility

This compatibility page is generated from canonical repo-owned source material in solarisara/jhf-spool.

Documentation Map

• Overview

• Quick Start

• Installation

• Configuration

• Operations

• Troubleshooting

• Release Notes

• Compatibility

• Channel: latest

• Source repo: solarisara/jhf-spool

Compatibility Sources

• README.md
• docs/OVERVIEW.md
• docs/INSTALL.md
• docs/CONFIGURATION.md
• docs/OPERATIONS.md
• docs/TROUBLESHOOTING.md
• docs/RELEASE_NOTES.md

Derived from Helpifyr Spool

News intelligence and evidence-memory service for Helpifyr/OpenClaw.

It ingests, retrieves, snapshots, exports, and enriches news evidence for downstream workflows while preserving strict truth boundaries.

Helpifyr Spool

jhf-spool (legacy alias: news-memory-platform) is the module that provides reproducible news evidence for product, operations, and support workflows in the Helpifyr stack.

It is a runtime module with its own API, persistence path, operational checks, and contract surfaces. It is not a control-plane owner for governance truth.

What It Is

jhf-spool is a service that turns incoming news source data into structured, queryable, and replay-capable evidence artifacts.

What It Does

• Runs ingestion jobs for historical and current news feeds.
• Serves authenticated retrieval/search for evidence consumers.
• Materializes snapshots and export artifacts for reproducible analysis.
• Supports evidence enrichment for support cases with replay-safe fallback behavior.
• Exposes health/readiness/metadata surfaces used by operations and downstream tooling.

Why It Matters

Many stack decisions need reliable evidence history, not only live fetches. jhf-spool provides that durable evidence plane while keeping boundaries explicit: it contributes evidence, but does not define global governance truth or case truth.

Stack Role

• Owns: news evidence ingestion/retrieval/export runtime and its API contract.
• Consumes: Fabric governance and profile truth in read-first mode.
• Does not own: Fabric control-plane truth, identity truth, or final case-truth decisions.

Core Features

• Ingestion jobs and job status tracking.
• Search, article retrieval, and versioned article views.
• Snapshot/export/replay artifact pipeline.
• Support evidence envelope enrichment.
• Operational release gates and runtime verification helpers.

Full feature and QA-ready coverage lives in docs/MODULE_FEATURES.md (docs/MODULE_FEATURES.md).

Available Now

• Maintained /v1 ingestion, search, article, snapshot, export, support, and operational gate surfaces.
• Public health/readiness/info and OpenAPI/docs discovery endpoints.
• Runtime stack contract and machine-readable runtime contract documents.
• Fabric read-first contract/profile consumption with local metadata projection.

Optional / Extended

• Optional n8n orchestration lane.
• Optional low-CPU compose override for constrained hosts.
• Optional provider-backed billing runtime when external rollout inputs are completed.

Planned / Not In Current Scope

• No Fabric write/control-plane ownership in this repository.
• No local replacement of Fabric canonical governance/profile truth.
• No local case-truth engine; support enrichment remains evidence-only by design.

Stack Relationships

Repo	Relationship
jhf-fabric	Upstream governance/profile truth consumed in read-first mode
jhf-openclaw-env	Runtime host and environment materialization for integrated deployments
jhf-shuttle	Optional n8n/workflow automation integration against Spool APIs
jhf-spindle	Business/account and billing-aligned operational flows
jhf-deployment	Deployment automation consumer of runtime and artifact contracts
jhf-dobby	Optional read-only evidence consumer in current v1 classification

Additional relationship details are in docs/STACK_RELATIONSHIPS.md (docs/STACK_RELATIONSHIPS.md).

Quick Verify / Quick Start

./scripts/dev-up.sh
python scripts/smoke-test.py --base-url http://<internal-runtime-redacted>:18080
python -m pytest -q tests/test_health.py tests/test_contract_matrix.py tests/test_config.py

For integrated-host validation and release checks, see docs/OPERATIONS.md.

Documentation

• Documentation Index
• Overview
• Feature Registry (QA Surface) (docs/MODULE_FEATURES.md)
• API Surfaces (docs/API.md)
• Operations
• Integrations (docs/INTEGRATIONS.md)
• Stack Contract (docs/STACK_CONTRACT.md)
• Fabric Tool Profile (docs/FABRIC_TOOL_PROFILE.md)
• Autonomous Backlog (docs/AUTONOMOUS_BACKLOG.md)

Status / Scope Notes

• State: active.
• Fabric integration posture: read-first consumer.
• Optional areas (billing-provider rollout and some external handoffs) are tracked as explicit backlog/issues and are not treated as fully completed by default.

License

AGPLv3. See LICENSE (LICENSE).

Learn more at helpifyr.com.