mirror of
https://github.com/Ed1s0nZ/CyberStrikeAI.git
synced 2026-07-16 00:47:29 +02:00
Add files via upload
This commit is contained in:
公明
+68
-51
@@ -1,68 +1,85 @@
|
||||
# CyberStrikeAI Documentation
|
||||
|
||||
Documentation is split by language:
|
||||
[中文](#中文文档) | [English](#english-documentation)
|
||||
|
||||
- [中文文档](zh-CN/)
|
||||
- [English docs](en-US/)
|
||||
CyberStrikeAI documentation is organized by user journey. Start with deployment, then move to the topic that matches your task.
|
||||
|
||||
## 中文文档
|
||||
|
||||
- [部署指南](zh-CN/deployment.md)
|
||||
- [运维 Runbooks](zh-CN/runbooks.md)
|
||||
- [配置画像](zh-CN/configuration-profiles.md)
|
||||
- [安全加固指南](zh-CN/security-hardening.md)
|
||||
- [API Recipes](zh-CN/api-recipes.md)
|
||||
- [贡献规范](zh-CN/contributing-guide.md)
|
||||
- [配置参考](zh-CN/configuration.md)
|
||||
- [安全模型](zh-CN/security-model.md)
|
||||
- [RBAC 权限管理](zh-CN/rbac.md)
|
||||
### 按目标开始
|
||||
|
||||
- **快速体验**：[部署指南](zh-CN/deployment.md) → [配置参考](zh-CN/configuration.md) → [排错指南](zh-CN/troubleshooting.md)
|
||||
- **生产部署**：[配置画像](zh-CN/configuration-profiles.md) → [安全加固](zh-CN/security-hardening.md) → [运维 Runbooks](zh-CN/runbooks.md) → [审计与监控](zh-CN/audit-and-monitoring.md)
|
||||
- **接入与自动化**：[API 参考](zh-CN/api-reference.md) → [API Recipes](zh-CN/api-recipes.md) → [MCP 联邦](zh-CN/mcp-federation.md)
|
||||
- **参与开发**：[开发者指南](zh-CN/developer-guide.md) → [测试指南](zh-CN/testing.md) → [贡献规范](zh-CN/contributing-guide.md)
|
||||
|
||||
### 核心概念与编排
|
||||
|
||||
- [架构说明](zh-CN/architecture.md)
|
||||
- [API 参考](zh-CN/api-reference.md)
|
||||
- [排错指南](zh-CN/troubleshooting.md)
|
||||
- [审计与监控](zh-CN/audit-and-monitoring.md)
|
||||
- [知识库](zh-CN/knowledge-base.md)
|
||||
- [C2 使用说明](zh-CN/c2.md)
|
||||
- [WebShell 管理](zh-CN/webshell.md)
|
||||
- [MCP 联邦](zh-CN/mcp-federation.md)
|
||||
- [安全模型](zh-CN/security-model.md)
|
||||
- [Agent 与角色](zh-CN/agent-and-role-guide.md)
|
||||
- [Skills 指南](zh-CN/skills-guide.md)
|
||||
- [插件开发](zh-CN/plugin-development.md)
|
||||
- [发布流程](zh-CN/release-process.md)
|
||||
- [测试指南](zh-CN/testing.md)
|
||||
- [图编排使用说明](zh-CN/workflow-graph.md)
|
||||
- [Eino 多代理](zh-CN/MULTI_AGENT_EINO.md)
|
||||
- [图编排](zh-CN/workflow-graph.md)
|
||||
- [人机协同最佳实践](zh-CN/hitl-best-practices.md)
|
||||
- [机器人使用说明](zh-CN/robot.md)
|
||||
|
||||
### 功能指南
|
||||
|
||||
- [知识库](zh-CN/knowledge-base.md)
|
||||
- [RBAC 权限管理](zh-CN/rbac.md)
|
||||
- [机器人接入](zh-CN/robot.md)
|
||||
- [视觉分析](zh-CN/VISION.md)
|
||||
- [前端国际化方案](zh-CN/frontend-i18n.md)
|
||||
- [Eino 多代理改造说明](zh-CN/MULTI_AGENT_EINO.md)
|
||||
- [WebShell 管理](zh-CN/webshell.md)
|
||||
- [C2 使用说明](zh-CN/c2.md)
|
||||
|
||||
## English Docs
|
||||
### 开发与发布
|
||||
|
||||
- [开发者指南](zh-CN/developer-guide.md)
|
||||
- [插件开发](zh-CN/plugin-development.md)
|
||||
- [前端国际化](zh-CN/frontend-i18n.md)
|
||||
- [测试指南](zh-CN/testing.md)
|
||||
- [贡献规范](zh-CN/contributing-guide.md)
|
||||
- [发布流程](zh-CN/release-process.md)
|
||||
|
||||
## English Documentation
|
||||
|
||||
### Choose a path
|
||||
|
||||
- **Try locally**: [Deployment](en-US/deployment.md) → [Configuration](en-US/configuration.md) → [Troubleshooting](en-US/troubleshooting.md)
|
||||
- **Run in production**: [Configuration Profiles](en-US/configuration-profiles.md) → [Security Hardening](en-US/security-hardening.md) → [Runbooks](en-US/runbooks.md) → [Audit and Monitoring](en-US/audit-and-monitoring.md)
|
||||
- **Integrate and automate**: [API Reference](en-US/api-reference.md) → [API Recipes](en-US/api-recipes.md) → [MCP Federation](en-US/mcp-federation.md)
|
||||
- **Contribute code**: [Developer Guide](en-US/developer-guide.md) → [Testing](en-US/testing.md) → [Contributing](en-US/contributing-guide.md)
|
||||
|
||||
### Concepts and orchestration
|
||||
|
||||
- [Deployment Guide](en-US/deployment.md)
|
||||
- [Runbooks](en-US/runbooks.md)
|
||||
- [Configuration Profiles](en-US/configuration-profiles.md)
|
||||
- [Security Hardening](en-US/security-hardening.md)
|
||||
- [API Recipes](en-US/api-recipes.md)
|
||||
- [Contributing Guide](en-US/contributing-guide.md)
|
||||
- [Configuration Reference](en-US/configuration.md)
|
||||
- [Security Model](en-US/security-model.md)
|
||||
- [RBAC Administration](en-US/rbac.md)
|
||||
- [Architecture](en-US/architecture.md)
|
||||
- [API Reference](en-US/api-reference.md)
|
||||
- [Troubleshooting](en-US/troubleshooting.md)
|
||||
- [Audit and Monitoring](en-US/audit-and-monitoring.md)
|
||||
- [Knowledge Base](en-US/knowledge-base.md)
|
||||
- [C2 Guide](en-US/c2.md)
|
||||
- [WebShell Management](en-US/webshell.md)
|
||||
- [MCP Federation](en-US/mcp-federation.md)
|
||||
- [Agent and Role Guide](en-US/agent-and-role-guide.md)
|
||||
- [Skills Guide](en-US/skills-guide.md)
|
||||
- [Plugin Development](en-US/plugin-development.md)
|
||||
- [Release Process](en-US/release-process.md)
|
||||
- [Testing Guide](en-US/testing.md)
|
||||
- [Graph Orchestration Guide](en-US/workflow-graph.md)
|
||||
- [Security Model](en-US/security-model.md)
|
||||
- [Agents and Roles](en-US/agent-and-role-guide.md)
|
||||
- [Skills](en-US/skills-guide.md)
|
||||
- [Eino Multi-Agent](en-US/MULTI_AGENT_EINO.md)
|
||||
- [Graph Orchestration](en-US/workflow-graph.md)
|
||||
- [HITL Best Practices](en-US/hitl-best-practices.md)
|
||||
- [Robot / Chatbot Guide](en-US/robot.md)
|
||||
|
||||
### Feature guides
|
||||
|
||||
- [Knowledge Base](en-US/knowledge-base.md)
|
||||
- [RBAC Administration](en-US/rbac.md)
|
||||
- [Robot / Chatbot](en-US/robot.md)
|
||||
- [Vision Analysis](en-US/VISION.md)
|
||||
- [WebShell Management](en-US/webshell.md)
|
||||
- [C2 Guide](en-US/c2.md)
|
||||
|
||||
### Development and release
|
||||
|
||||
- [Developer Guide](en-US/developer-guide.md)
|
||||
- [Plugin Development](en-US/plugin-development.md)
|
||||
- [Frontend i18n](en-US/frontend-i18n.md)
|
||||
- [Eino Multi-Agent Notes](en-US/MULTI_AGENT_EINO.md)
|
||||
- [Testing](en-US/testing.md)
|
||||
- [Contributing](en-US/contributing-guide.md)
|
||||
- [Release Process](en-US/release-process.md)
|
||||
|
||||
## Documentation conventions
|
||||
|
||||
- Commands assume the repository root unless stated otherwise.
|
||||
- Examples use placeholders; never commit real credentials or target systems without explicit authorization.
|
||||
- Runtime behavior and configuration defaults are authoritative in `config.example.yaml` and the source code. If a document differs, report it as documentation drift.
|
||||
|
||||
+31
-29
@@ -1,30 +1,32 @@
|
||||
# English Docs
|
||||
# English Documentation
|
||||
|
||||
- [Deployment Guide](deployment.md): deployment modes, HTTPS, reverse proxy, systemd, backup, upgrade, and acceptance checks.
|
||||
- [Runbooks](runbooks.md): operational steps for production setup, external MCP, KB, Web testing, C2 cleanup, and tool debugging.
|
||||
- [Configuration Profiles](configuration-profiles.md): recommended profiles for dev, internal team, knowledge-only, production, C2, and MCP automation.
|
||||
- [Security Hardening](security-hardening.md): pre-launch baseline, reverse proxy, HITL allowlist, file permissions, and periodic review.
|
||||
- [API Recipes](api-recipes.md): examples for login, Agent, streaming, multi-agent, uploads, vulnerabilities, KB, MCP, and audit export.
|
||||
- [Contributing Guide](contributing-guide.md): checklists for APIs, config, tools, frontend, DB, high-risk features, and docs.
|
||||
- [Configuration Reference](configuration.md): `config.yaml` fields, hot-apply boundaries, recommended values, and source anchors.
|
||||
- [Security Model](security-model.md): trust boundaries, HITL, tool execution, C2/WebShell, and data safety.
|
||||
- [RBAC Administration](rbac.md): platform users, system/custom roles, permission catalog, per-permission scopes, resource assignments, Agent/MCP/robot boundaries, and API examples.
|
||||
- [Architecture](architecture.md): request flow, module relationships, complexity hotspots, and design trade-offs.
|
||||
- [API Reference](api-reference.md): authentication, OpenAPI, SSE, stability tiers, and common endpoints.
|
||||
- [Troubleshooting](troubleshooting.md): diagnostic order, minimal commands, common misdiagnoses, and issue template.
|
||||
- [Audit and Monitoring](audit-and-monitoring.md): platform audit, tool monitoring, HITL logs, and retention.
|
||||
- [Knowledge Base](knowledge-base.md): indexing pipeline, retrieval tuning, log analysis, and content writing.
|
||||
- [C2 Guide](c2.md): lifecycle, task classification, event review, and safety guidance.
|
||||
- [WebShell Management](webshell.md): operation tiers, naming, AI guardrails, and troubleshooting.
|
||||
- [MCP Federation](mcp-federation.md): built-in MCP, external MCP, lifecycle, and tool naming.
|
||||
- [Agent and Role Guide](agent-and-role-guide.md): roles, sub-agents, Skills, orchestration modes, and tool visibility.
|
||||
- [Skills Guide](skills-guide.md): Skill structure, progressive disclosure, anti-patterns, and local-tool risk.
|
||||
- [Plugin Development](plugin-development.md): API plugins, MCP plugins, resource-pack plugins, and security boundaries.
|
||||
- [Release Process](release-process.md): release risk, config compatibility, DB migrations, and acceptance checks.
|
||||
- [Testing Guide](testing.md): test layers, regression focus, test data, and failure cases.
|
||||
- [Graph Orchestration Guide](workflow-graph.md)
|
||||
- [HITL Best Practices](hitl-best-practices.md)
|
||||
- [Robot / Chatbot Guide](robot.md)
|
||||
- [Vision Analysis](VISION.md)
|
||||
- [Frontend i18n](frontend-i18n.md)
|
||||
- [Eino Multi-Agent Notes](MULTI_AGENT_EINO.md)
|
||||
[Documentation home](../README.md) | [中文](../zh-CN/README.md)
|
||||
|
||||
## Choose a path
|
||||
|
||||
- **Try locally**: [Deployment](deployment.md) → [Configuration](configuration.md) → [Troubleshooting](troubleshooting.md)
|
||||
- **Run in production**: [Configuration Profiles](configuration-profiles.md) → [Security Hardening](security-hardening.md) → [Runbooks](runbooks.md) → [Audit and Monitoring](audit-and-monitoring.md)
|
||||
- **Integrate and automate**: [API Reference](api-reference.md) → [API Recipes](api-recipes.md) → [MCP Federation](mcp-federation.md)
|
||||
- **Contribute code**: [Developer Guide](developer-guide.md) → [Testing](testing.md) → [Contributing](contributing-guide.md)
|
||||
|
||||
## Concepts and orchestration
|
||||
|
||||
- [Architecture](architecture.md) · [Security Model](security-model.md) · [RBAC](rbac.md)
|
||||
- [Agents and Roles](agent-and-role-guide.md) · [Skills](skills-guide.md) · [Eino Multi-Agent](MULTI_AGENT_EINO.md)
|
||||
- [Graph Orchestration](workflow-graph.md) · [HITL Best Practices](hitl-best-practices.md)
|
||||
|
||||
## Feature guides
|
||||
|
||||
- [Knowledge Base](knowledge-base.md) · [Robot / Chatbot](robot.md) · [Vision](VISION.md)
|
||||
- [WebShell](webshell.md) · [C2](c2.md) · [MCP Federation](mcp-federation.md)
|
||||
|
||||
## Operations and reference
|
||||
|
||||
- [Deployment](deployment.md) · [Configuration](configuration.md) · [Configuration Profiles](configuration-profiles.md)
|
||||
- [Security Hardening](security-hardening.md) · [Audit and Monitoring](audit-and-monitoring.md) · [Runbooks](runbooks.md)
|
||||
- [API Reference](api-reference.md) · [API Recipes](api-recipes.md) · [Troubleshooting](troubleshooting.md)
|
||||
|
||||
## Development and release
|
||||
|
||||
- [Developer Guide](developer-guide.md) · [Plugin Development](plugin-development.md) · [Frontend i18n](frontend-i18n.md)
|
||||
- [Testing](testing.md) · [Contributing](contributing-guide.md) · [Release Process](release-process.md)
|
||||
|
||||
@@ -103,6 +103,14 @@ Update:
|
||||
- `docs/zh-CN/README.md`
|
||||
- `docs/en-US/README.md`
|
||||
|
||||
Before submitting documentation changes, run:
|
||||
|
||||
```bash
|
||||
python3 scripts/check-docs.py
|
||||
```
|
||||
|
||||
The check verifies local links, fenced code blocks, bilingual filename parity, locale index coverage, and the Go version documented by the root READMEs. Keep versioned examples derived from authoritative files such as `go.mod` and `config.example.yaml` whenever possible.
|
||||
|
||||
## Review Focus
|
||||
|
||||
Prioritize:
|
||||
|
||||
+30
-28
@@ -1,30 +1,32 @@
|
||||
# 中文文档
|
||||
|
||||
- [部署指南](deployment.md)：部署形态、HTTPS、反向代理、systemd、备份、升级和验收。
|
||||
- [运维 Runbooks](runbooks.md)：生产部署、外部 MCP、知识库、Web 测试、C2 清理和工具排障的操作步骤。
|
||||
- [配置画像](configuration-profiles.md)：本地开发、内网团队、知识库、高审计生产、C2 演练等推荐配置。
|
||||
- [安全加固指南](security-hardening.md)：上线前基线、反向代理、HITL 白名单、文件权限和周期巡检。
|
||||
- [API Recipes](api-recipes.md)：登录、Agent、流式、多代理、上传、漏洞、知识库、MCP 和审计导出示例。
|
||||
- [贡献规范](contributing-guide.md)：新增 API、配置、工具、前端、数据库、高风险能力和文档的 checklist。
|
||||
- [配置参考](configuration.md)：`config.yaml` 字段、热应用边界、参数建议和源码锚点。
|
||||
- [安全模型](security-model.md)：信任边界、HITL、工具执行、C2/WebShell 与数据安全。
|
||||
- [RBAC 权限管理](rbac.md)：平台用户、系统/自定义角色、权限目录、逐权限 Scope、资源授权、Agent/MCP/机器人边界与 API 示例。
|
||||
- [架构说明](architecture.md)：请求路径、模块关系、复杂度热点和设计取舍。
|
||||
- [API 参考](api-reference.md)：认证、OpenAPI、SSE、稳定性分层和常用接口。
|
||||
- [排错指南](troubleshooting.md)：诊断顺序、最小命令、常见误判和故障模板。
|
||||
- [审计与监控](audit-and-monitoring.md)：平台审计、工具监控、HITL 日志和保留策略。
|
||||
- [知识库](knowledge-base.md)：索引链路、检索调参、日志分析和内容写法。
|
||||
- [C2 使用说明](c2.md)：生命周期、任务分级、事件复盘和安全建议。
|
||||
- [WebShell 管理](webshell.md)：操作分层、连接命名、AI 约束和排错。
|
||||
- [MCP 联邦](mcp-federation.md)：内置 MCP、外部 MCP、生命周期和工具命名。
|
||||
- [Agent 与角色](agent-and-role-guide.md)：角色、子代理、Skill、编排模式和工具可见性。
|
||||
- [Skills 指南](skills-guide.md)：Skill 结构、渐进式披露、反模式和本地工具风险。
|
||||
- [插件开发](plugin-development.md)：API 插件、MCP 插件、资源包插件和安全边界。
|
||||
- [发布流程](release-process.md)：发布风险、配置兼容、数据库迁移和验收。
|
||||
- [测试指南](testing.md)：测试分层、回归重点、测试数据和失败用例。
|
||||
- [图编排使用说明](workflow-graph.md)
|
||||
- [人机协同最佳实践](hitl-best-practices.md)
|
||||
- [机器人使用说明](robot.md)
|
||||
- [视觉分析](VISION.md)
|
||||
- [前端国际化方案](frontend-i18n.md)
|
||||
- [Eino 多代理改造说明](MULTI_AGENT_EINO.md)
|
||||
[文档首页](../README.md) | [English](../en-US/README.md)
|
||||
|
||||
## 按目标开始
|
||||
|
||||
- **快速体验**：[部署指南](deployment.md) → [配置参考](configuration.md) → [排错指南](troubleshooting.md)
|
||||
- **生产部署**：[配置画像](configuration-profiles.md) → [安全加固](security-hardening.md) → [运维 Runbooks](runbooks.md) → [审计与监控](audit-and-monitoring.md)
|
||||
- **接入与自动化**：[API 参考](api-reference.md) → [API Recipes](api-recipes.md) → [MCP 联邦](mcp-federation.md)
|
||||
- **参与开发**：[开发者指南](developer-guide.md) → [测试指南](testing.md) → [贡献规范](contributing-guide.md)
|
||||
|
||||
## 核心概念与编排
|
||||
|
||||
- [架构说明](architecture.md) · [安全模型](security-model.md) · [RBAC](rbac.md)
|
||||
- [Agent 与角色](agent-and-role-guide.md) · [Skills](skills-guide.md) · [Eino 多代理](MULTI_AGENT_EINO.md)
|
||||
- [图编排](workflow-graph.md) · [人机协同最佳实践](hitl-best-practices.md)
|
||||
|
||||
## 功能指南
|
||||
|
||||
- [知识库](knowledge-base.md) · [机器人接入](robot.md) · [视觉分析](VISION.md)
|
||||
- [WebShell](webshell.md) · [C2](c2.md) · [MCP 联邦](mcp-federation.md)
|
||||
|
||||
## 运维与参考
|
||||
|
||||
- [部署指南](deployment.md) · [配置参考](configuration.md) · [配置画像](configuration-profiles.md)
|
||||
- [安全加固](security-hardening.md) · [审计与监控](audit-and-monitoring.md) · [运维 Runbooks](runbooks.md)
|
||||
- [API 参考](api-reference.md) · [API Recipes](api-recipes.md) · [排错指南](troubleshooting.md)
|
||||
|
||||
## 开发与发布
|
||||
|
||||
- [开发者指南](developer-guide.md) · [插件开发](plugin-development.md) · [前端国际化](frontend-i18n.md)
|
||||
- [测试指南](testing.md) · [贡献规范](contributing-guide.md) · [发布流程](release-process.md)
|
||||
|
||||
@@ -5,7 +5,7 @@ CyberStrikeAI 的主配置文件是 `config.yaml`。大多数配置也可以在
|
||||
## 基础配置
|
||||
|
||||
```yaml
|
||||
version: "v1.6.51"
|
||||
version: "vX.Y.Z" # 占位符；请使用 config.example.yaml 中当前发布版本的值
|
||||
server:
|
||||
host: 0.0.0.0
|
||||
port: 8080
|
||||
@@ -22,7 +22,6 @@ log:
|
||||
- `server.host/port`：Web 服务监听地址和端口。
|
||||
- `server.tls_*`：HTTPS 配置。生产环境建议使用 `tls_cert_path` 和 `tls_key_path`。
|
||||
- `auth.session_duration_hours`：登录会话有效期（小时）。登录密码由 RBAC 用户管理，首次启动时在控制台输出 `admin` 初始密码。
|
||||
- `auth.session_duration_hours`：登录会话有效期。
|
||||
- `log.output`：可以是 `stdout`、`stderr` 或文件路径。
|
||||
|
||||
## 模型配置
|
||||
|
||||
@@ -103,6 +103,14 @@ docs/en-US/
|
||||
- `docs/zh-CN/README.md`
|
||||
- `docs/en-US/README.md`
|
||||
|
||||
提交文档变更前运行：
|
||||
|
||||
```bash
|
||||
python3 scripts/check-docs.py
|
||||
```
|
||||
|
||||
该检查会验证本地链接、代码块闭合、中英文文件名对齐、语言导航覆盖率，以及根 README 中的 Go 版本是否与 `go.mod` 一致。版本化示例应尽量从 `go.mod`、`config.example.yaml` 等权威文件派生，避免手工同步。
|
||||
|
||||
## Review 关注点
|
||||
|
||||
代码评审优先看：
|
||||
|
||||
Reference in New Issue
Block a user