Skip to content
scottcwyPublic

About

seoaudit 是一个开源的中文 SEO 审计工具,提供网站抓取、问题检测与报告导出能力。

Resources

Stars

7 stars

Watchers

0 watching

Forks

Repository files navigation

seoaudit

seoaudit 是一个开源、可本地部署的 SEO 审计工具。它可以抓取站点页面,分析标题、描述、索引状态、链接、媒体资源、安全响应头、站点地图、robots.txt 等常见 SEO 与技术健康问题,并通过中文界面展示审计结果。

项目适合个人站长、SEO 从业者、内容团队、开发团队在本地或内网环境中复盘网站问题,也适合作为 Go Web 项目的学习样例。

功能特性

  • 网站抓取:按项目配置抓取站点页面、资源与链接关系。
  • 页面级审计:检测标题、描述、canonical、hreflang、robots、noindex、nofollow、状态码、页面深度等问题。
  • 资源分析:汇总内部链接、外部链接、图片、脚本、样式、iframe、音频、视频等资源。
  • 站点地图与 robots 检查:支持 sitemap 抓取、robots.txt 规则判断与相关问题识别。
  • 安全与技术 SEO 检测:覆盖 HSTS、CSP、X-Content-Type-Options、TTFB、DOM size、viewport 等常见检查项。
  • 实时抓取进度:通过 WebSocket 展示抓取过程和统计进度。
  • 报告导出:支持 CSV、sitemap、资源列表、WAZC/WARC 类归档等导出能力。
  • 中文界面:默认语言为中文,适合中文团队直接使用。
  • Docker 部署:内置 MySQL 与应用服务的 Docker Compose 配置。

技术栈

  • 后端:Go 1.25
  • Web:Go HTML templates + CSS
  • 数据库:MySQL 8.4
  • 数据迁移:golang-migrate
  • 前端构建:esbuild
  • 容器化:Docker + Docker Compose

项目结构

.
|-- cmd/server/              # 应用入口
|-- internal/config/         # 配置加载
|-- internal/crawler/        # 抓取、队列、robots、sitemap 相关逻辑
|-- internal/models/         # 领域模型
|-- internal/repository/     # 数据访问层
|-- internal/routes/         # HTTP 路由与页面处理
|-- internal/services/       # 业务服务、报告、导出、渲染
|-- migrations/              # MySQL 数据库迁移
|-- translations/            # 界面文案翻译
|-- web/css/                 # 样式源码
|-- web/fonts/               # 字体资源
|-- web/templates/           # HTML 模板
|-- Dockerfile
|-- docker-compose.yml
|-- docker-compose.dev.yml
`-- config                   # 默认配置文件

快速开始

推荐使用 Docker Compose。它会同时启动 MySQL 和 seoaudit 应用。

1. 克隆仓库

git clone https://github.com/scottcwy/seoaudit.git
cd seoaudit

2. 启动服务

docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build

3. 打开应用

访问:

http://localhost:9000

默认应用端口为 9000,默认 MySQL 端口为 3306。

常用 Docker 命令

# 查看容器状态
docker compose -f docker-compose.yml -f docker-compose.dev.yml ps

# 查看应用日志
docker logs -f seoaudit-app

# 查看数据库日志
docker logs -f seoaudit-db

# 停止服务
docker compose -f docker-compose.yml -f docker-compose.dev.yml down

# 重新构建并启动
docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build

配置说明

默认配置文件是 config。

[server]
host = "0.0.0.0"
port = 9000
url = "http://localhost:9000"

[database]
server = "db"
port = 3306
user = "seoaudit"
password = "seoaudit"
database = "seoaudit"

[crawler]
agent = "Mozilla/5.0 (compatible; SEOAuditBot/1.0)"

[UI]
language = "zh"
theme = "dark"

Docker Compose 默认会创建:

  • 数据库:seoaudit
  • 数据库用户:seoaudit
  • 数据库密码:seoaudit
  • root 密码:root

应用使用 SEOAUDIT_ 作为环境变量前缀。可以通过环境变量覆盖配置项,例如:

SEOAUDIT_PORT=9100 docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build

本地开发

不使用 Docker 时,需要先准备:

  • Go 1.25+
  • MySQL 8+
  • esbuild
  • 可用的本地配置文件 config.local

启动后端:

make run

运行测试:

make test

运行 go vet:

make vet

运行 lint:

make lint

构建前端静态资源:

make front

开发时监听前端样式变更:

make watch

Makefile 命令

make run        启动本地服务,读取 config.local
make test       运行 Go 测试
make vet        运行 go vet
make lint       运行 golangci-lint
make lint-fix   自动修复可修复的 lint 问题
make docker     使用 Docker Compose 构建并启动
make front      使用 esbuild 构建前端资源
make watch      监听前端样式并持续构建
make clean      清理 Docker builder 缓存

使用流程

  1. 打开首页,创建一个项目。
  2. 填写要审计的网站地址,并按需启用 sitemap、子域名、Basic Auth、自定义 User-Agent 等选项。
  3. 启动抓取任务,在实时进度页观察抓取状态。
  4. 抓取完成后进入 dashboard 查看问题分布、状态码、资源类型、链接类型、时间线等图表。
  5. 在 Issues、Explorer、Resources 等页面查看具体 URL 与资源明细。
  6. 在 Export 页面导出 CSV、sitemap、资源清单或归档数据,用于复盘和协作。

导出内容

应用提供多种导出入口,常见包括:

  • sitemap
  • 页面报告 CSV
  • 内部链接
  • 外部链接
  • 图片资源
  • 脚本资源
  • 样式资源
  • iframe
  • 音频与视频
  • hreflang
  • issue 明细
  • WAZC/WARC 类抓取归档

排障

端口被占用

如果 9000 或 3306 已被占用,可以改用其他端口:

SEOAUDIT_PORT=9100 MYSQL_PORT=3307 docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build

应用一直等待数据库

先确认 MySQL 容器是否已经启动:

docker logs -f seoaudit-db
docker logs -f seoaudit-app

应用容器会等待 db:3306 可用后再启动服务。首次拉取镜像或初始化数据库时可能需要更久。

修改样式后页面没有变化

Docker 镜像会在构建时打包前端资源。修改 web/css 后需要重新构建镜像:

docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --build

本地开发时可以使用:

make watch

贡献

欢迎提交 issue 和 pull request。建议在提交前运行:

make test
make vet

如果修改了前端样式或模板,也建议重新构建并在浏览器中检查主要页面。

许可证

本项目使用 MIT License。详见 LICENSE 与 LICENSE.zh-CN.md。

About

seoaudit 是一个开源的中文 SEO 审计工具,提供网站抓取、问题检测与报告导出能力。

Resources

Stars

7 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages