feat: enhance documentation with security and operations guidelines#966
feat: enhance documentation with security and operations guidelines#966
Conversation
Signed-off-by: CFC4N <cfc4n.cs@gmail.com>
|
🔧 Debug Build Complete (PR #966) 📦 Download Links: ⏰ Files will be retained for 7 days, please download and test promptly. This build includes debug binaries for: android/linux (arm64/amd64) |
There was a problem hiding this comment.
Pull request overview
This PR expands and reorganizes project documentation to better cover security/least-privilege operation, operational guidance (performance + release integrity), and contributor/agent workflow expectations across both English and Chinese entrypoints.
Changes:
- Add new security/operations documentation (minimum privileges, defense/detection, performance benchmarks, release verification) and link it from docs index + READMEs.
- Update
README.mdandREADME-zh_Hans.mdto clarify privilege requirements and streamline output examples by linking to a dedicated examples document. - Rewrite/expand the PR agent profile and formalize security/CI/testing expectations; refresh
SECURITY.mdpolicy content.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/release-verification.md | Adds a guide for verifying release artifacts and Docker images |
| docs/performance-benchmarks.md | Adds benchmark methodology + expected overhead guidance |
| docs/minimum-privileges.md | Documents least-privilege capability setups (sudo/setcap/Docker) |
| docs/example-outputs.md | Centralizes verbose example outputs referenced by READMEs |
| docs/defense-detection.md | Adds detection/defense guidance for eBPF-based capture tools |
| docs/README.md | Links new security/ops docs and example outputs from the docs index |
| SECURITY.md | Replaces template with supported versions + vuln reporting process |
| README.md | Clarifies privilege needs, adds Security & Operations section, trims logs |
| README-zh_Hans.md | Chinese equivalent of README security/ops and output simplification updates |
| .github/agents/pr-agent.md | Expanded agent profile with repo structure, constraints, CI/testing expectations |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
✅ E2E Test Results: PASSEDTest Run: #23685857872 Tests Executed:
✅ All e2e tests passed successfully! The TLS capture functionality is working correctly. Automated e2e test results for commit 0a015f0 |
This pull request updates the documentation for both the English (
README.md) and Chinese (README-zh_Hans.md) readme files, as well as the PR agent profile, to improve clarity, enhance security guidance, and provide more comprehensive operational and contribution instructions. The changes focus on making privilege requirements clearer, adding security best practices, improving output examples, and refining the PR agent's workflow and constraints.Key changes include:
Security and Privilege Guidance
Clearly state that running eCapture requires either root privileges or specific Linux capabilities, and link to a new "Minimum Privileges Guide" for more secure deployments. This is reflected in both readme files and the Docker usage instructions. [1] [2] [3] [4]
Add explicit security warnings about using
--privileged=truewith Docker, recommending the use of specific capabilities instead, and link to detailed documentation for secure container deployment. [1] [2]Introduce a new "Security & Operations" (English) / "安全与运维" (Chinese) section in the table of contents and main body, with links to security policy, privilege guides, detection/defense, performance benchmarks, and release verification. [1] [2] [3]
Output and Usage Documentation
Streamline and clarify the output examples for both plaintext and pcapng capture modes, referencing a new
docs/example-outputs.mdfor complete outputs, and removing overly verbose logs from the main readme. [1] [2] [3]Add notes and references for using and interpreting output files, and highlight the importance of using provided scripts and tools for e2e testing. [1] [2]
PR Agent Profile and Contribution Process
General Improvements
These changes collectively improve the project's documentation quality, security posture, and contributor guidance.
References: [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]