Enforce a truthful local-first AI/privacy contract
Template tests / tests (pull_request) Failing after 34s
Template tests / tests (pull_request) Failing after 34s
Phase 1 of the improvement plan (PR 3 of the sequence). The docs claimed "fully offline"/"never talks to the network," but text-intel makes HTTP requests to a configurable Ollama host that could be remote, with no timeout, no cancellation, and no size limit; the Windows hook logged raw keystrokes into capture metadata that could then be sent to that host. Privacy — raw keystroke capture: - New capture.captureTypedText setting, default false. With it off, printable characters are never buffered in JS and the Windows keyboard hook never even emits them across the process boundary (the flag is threaded into the C#). Shortcut/navigation detection (Ctrl+T, Enter, …) is unaffected. AI network hardening (app/text-intel.js): - Every Ollama call goes through fetchJson with an AbortController deadline (ai.timeoutMs, default 60s): a dead endpoint fails fast instead of leaving UI actions pending forever. - Cancellation: in-flight requests are tracked and cancelInflight(guideId) aborts them; new ai:cancel IPC + api.ai.cancel are called when the editor closes, and shutdown cancels everything. - Bounded concurrency (2) for AI network work. - Screenshots are only attached when allowed (ai.attachScreenshots), the model is vision-capable, and the image is within ai.maxImageBytes — no more unbounded base64-expanded 4K bodies. Local-first host policy (core/text-intel.js): - New isLoopbackHost + validateOllamaHost. By default only a loopback Ollama endpoint is contacted; a remote host is refused with a clear message unless ai.allowRemoteHost is explicitly enabled. Blocked hosts are never contacted. Honest documentation: - README, package.json, and the welcome screen drop "fully offline"/"never talks to the network"/"Electron is the only dependency" for an accurate local-first contract that discloses the optional AI path and the bundled Tesseract OCR dependency. - New docs/PRIVACY.md details exactly what is collected locally and the one outbound (opt-in, loopback-by-default) AI feature. Tests: loopback/remote host matrix, remote-blocked-without-opt-in (and never contacted), remote-allowed-with-opt-in, request timeout, explicit cancel vs timeout, typed-text off-by-default vs opted-in, shortcut detection still works, and a source guard that the C# CHAR emission stays behind the opt-in. 224 unit tests pass; startup smoke and workflow E2E pass. Co-Authored-By: Claude Fable 5 <[email protected]>
This commit is contained in:
@@ -1,17 +1,26 @@
|
||||
# StepForge
|
||||
|
||||
StepForge is a **fully offline**, open-source desktop app for Windows, with
|
||||
StepForge is a **local-first**, open-source desktop app for Windows, with
|
||||
Linux (WIP) builds. It captures step-by-step workflows as screenshots, lets
|
||||
you annotate and describe each step in a focused three-pane editor, and
|
||||
exports the result to Markdown, DOCX, PPTX, PDF, HTML (WIP), GIF (WIP),
|
||||
confluence (WIP), Wiki.js (WIP), and image bundles (WIP). The current
|
||||
reconmendations for exporting is Markdown and PDF.
|
||||
|
||||
It is an independent offline desktop guide-capture tool inspired by publicly
|
||||
documented workflow patterns of commercial documentation tools like Folge. It contains no
|
||||
third-party branding, assets, or code from those tools, and it never talks to
|
||||
the network: no telemetry, no update checks, no license checks, no cloud, no
|
||||
remote AI.
|
||||
It is an independent desktop guide-capture tool inspired by publicly
|
||||
documented workflow patterns of commercial documentation tools like Folge. It
|
||||
contains no third-party branding, assets, or code from those tools.
|
||||
|
||||
**Network and privacy contract.** StepForge has no telemetry, no update
|
||||
checks, no license checks, and no cloud. Guides never leave your machine on
|
||||
their own. The only outbound network feature is the **optional** AI
|
||||
integration: when *you* enable it and configure an [Ollama](https://ollama.com)
|
||||
endpoint, StepForge sends step screenshots and text to that endpoint to
|
||||
generate titles and descriptions. By default that endpoint must be **local
|
||||
(loopback)**; sending data to a remote host requires the explicit "Allow
|
||||
remote AI host" opt-in. See [docs/PRIVACY.md](docs/PRIVACY.md) for exactly
|
||||
what is collected and sent. Note that OCR (Tesseract) and its English language
|
||||
data are bundled production dependencies — Electron is not the only one.
|
||||
|
||||
## Overview
|
||||
|
||||
|
||||
Reference in New Issue
Block a user