gowitness 项目教程

1. 项目的目录结构及介绍

gowitness 是一个使用 Golang 编写的网站截图工具，利用 Chrome Headless 生成网页截图。以下是项目的目录结构及各部分介绍：

gowitness/
├── cmd/
│   └── gowitness/
│       └── main.go  # 主程序入口
├── internal/
│   ├── browser/  # 浏览器相关操作
│   ├── config/   # 配置文件处理
│   ├── report/   # 报告生成
│   ├── screenshot/  # 截图操作
│   └── util/     # 工具函数
├── pkg/
│   ├── chromedp/  # chromedp 库封装
│   ├── gorm/      # gorm 库封装
│   ├── tabler/    # tabler 库封装
│   └── zerolog/   # zerolog 库封装
├── Dockerfile  # Docker 配置文件
├── Makefile    # 构建脚本
├── README.md   # 项目说明文档
└── go.mod      # Go 模块文件

目录结构说明

• cmd/: 包含主程序入口文件 main.go。
• internal/: 包含项目的核心逻辑，如浏览器操作、配置处理、报告生成和截图操作等。
• pkg/: 包含第三方库的封装，如 chromedp、gorm、tabler 和 zerolog 等。
• Dockerfile: 用于构建 Docker 镜像。
• Makefile: 包含项目的构建脚本。
• README.md: 项目说明文档。
• go.mod: Go 模块文件，定义项目依赖。

2. 项目的启动文件介绍

项目的启动文件位于 cmd/gowitness/main.go。该文件是 gowitness 的入口点，负责初始化配置、启动浏览器实例并执行截图操作。

package main

import (
    "github.com/sensepost/gowitness/cmd"
)

func main() {
    cmd.Execute()
}

启动文件说明

• main.go: 主程序入口，调用 cmd 包中的 Execute 函数启动程序。

3. 项目的配置文件介绍

gowitness 的配置文件通常通过命令行参数或环境变量进行设置。以下是一些常用的配置选项：

常用配置选项

• --url: 指定要截图的 URL。
• --output: 指定截图保存的目录。
• --format: 指定截图的格式（如 png、jpg）。
• --delay: 指定页面加载后的等待时间。
• --chrome-path: 指定 Chrome 浏览器的路径。

配置文件示例

gowitness --url https://example.com --output ./screenshots --format png --delay 5 --chrome-path /path/to/chrome

配置文件说明

• 通过命令行参数传递配置选项，灵活控制截图行为。

以上是 gowitness 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用 gowitness 项目。