docs: add binary integrity verification section (P0-4)#43
Merged
Conversation
Document the checksum verification behavior, CAPISCIO_SKIP_CHECKSUM env var, and add troubleshooting entry for checksum failures. Ref: DOCS_REMEDIATION_PLAN P0-4 Part B
There was a problem hiding this comment.
Pull request overview
Adds documentation describing how the Node.js wrapper verifies the downloaded capiscio-core binary integrity, and how to troubleshoot checksum-related download failures.
Changes:
- Adds a “Binary Integrity Verification” README section describing SHA-256 verification and
CAPISCIO_SKIP_CHECKSUM. - Adds a troubleshooting entry for checksum verification failures.
Comment on lines
+83
to
+88
| If verification fails or the checksums file is unavailable: | ||
|
|
||
| ```bash | ||
| # Temporary bypass (not recommended for production) | ||
| export CAPISCIO_SKIP_CHECKSUM=true | ||
| ``` |
| If you are behind a corporate firewall, ensure you can access `github.com`. | ||
|
|
||
| **Checksum verification failures:** | ||
| If you see "Checksum verification failed", the binary integrity could not be confirmed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Document the checksum verification behavior for the capiscio-core binary download.
Documentation Audit Reference
Phase: P0-4
Severity: Critical
Changes
README.md: Added "Binary Integrity Verification" section documentingCAPISCIO_SKIP_CHECKSUMenv varREADME.md: Added troubleshooting entry for checksum verification failuresVerification
src/utils/binary-manager.ts