浏览代码

Add: 添加报告模板 & 更新README

iaun 2 月之前
父节点
当前提交
4f719104a0
共有 2 个文件被更改,包括 43 次插入1 次删除
  1. 43 1
      README.md
  2. 二进制
      [Client Name]-[Project Name]-Project-Report-v1.0.docx

+ 43 - 1
README.md

@@ -72,11 +72,18 @@
 - **Node.js 18+**
 - **Redis** (必需,用于Celery任务队列)
 
-### 1. 克隆项目
+### 1. 克隆项目并准备模板
 
 ```bash
 git clone https://git.iaun.cn/iaun/cloud-reporter.git
 cd cloud-reporter
+
+mkdir sample-reports
+
+# 复制报告模板到 sample-reports 文件夹
+copy "[Client Name]-[Project Name]-Project-Report-v1.0.docx" sample-reports/
+# Unix/Linux/macOS:
+# cp "[Client Name]-[Project Name]-Project-Report-v1.0.docx" sample-reports/
 ```
 
 ### 2. 后端设置
@@ -444,6 +451,41 @@ docker-compose up -d
 
 ## 🔍 故障排除
 
+### CloudShell Scanner (独立扫描工具)
+
+除了完整的Web应用外,项目还提供了一个独立的CloudShell扫描脚本 `cloudshell_scanner.py`,可以直接在AWS CloudShell环境中运行,无需配置Access Key。
+
+#### 功能特点
+- **单文件脚本** - 仅依赖boto3和Python标准库
+- **自动使用CloudShell IAM凭证** - 无需配置Access Key
+- **多区域扫描** - 支持指定区域或扫描所有可用区域
+- **进度显示** - 实时显示扫描进度
+- **错误处理** - 自动重试和错误记录
+
+#### 使用方法
+
+```bash
+# 在AWS CloudShell中运行
+
+# 扫描所有区域
+python cloudshell_scanner.py
+
+# 扫描指定区域
+python cloudshell_scanner.py --regions us-east-1,ap-northeast-1
+
+# 指定输出文件
+python cloudshell_scanner.py --output my_scan.json
+
+# 扫描指定服务
+python cloudshell_scanner.py --services ec2,vpc,rds
+```
+
+#### 支持的服务
+与Web应用支持相同的30+AWS服务类型,包括VPC、EC2、RDS、S3、Lambda、EKS等。
+
+#### 输出格式
+扫描结果以JSON格式输出,可直接上传到Web应用生成报告。
+
 ### 常见问题
 
 #### 后端问题

二进制
[Client Name]-[Project Name]-Project-Report-v1.0.docx