fruggr/scanner

Fruggr Scanner

镜像概述和主要用途

Fruggr Scanner 是 fruggr.io 的自主分析模块，后者是衡量数字服务环境和社会影响的参考工具。该镜像提供自动化分析能力，支持集成到开发流程中，帮助用户评估数字服务的可持续性指标。

核心功能和特性

• 自动化影响评估：对数字服务的环境和社会影响进行量化分析
• 多环境集成：支持本地命令行运行及 CI/CD 流水线集成（如 GitLab CI/CD、Azure DevOps 等）
• 灵活配置选项：可自定义分析范围（页面数量、域名过滤）及认证方式
• Git 仓库联动：支持从指定 Git 仓库拉取代码进行深度分析，并配置访问权限
• 版本自动更新：通过 latest 标签自动获取最新分析规则和功能

使用场景和适用范围

适用场景

• 本地开发验证：开发人员在本地环境手动触发数字服务影响评估
• 持续集成流程：在代码推送、合并等开发环节自动执行影响分析
• 定期合规检查：通过定时任务对生产环境数字服务进行周期性影响监测

适用范围

• 需衡量数字服务可持续性指标的开发团队
• 希望将环境影响评估纳入 DevOps 流程的组织
• 需满足企业社会责任或环境***要求的数字服务项目

详细使用方法和配置说明

前置条件

使用前需在 fruggr.io 注册账户，并在目标数字服务的“参数”选项卡中获取 API 密钥（FRUGGR_API_KEY）。

命令行使用

通过 Docker 直接运行分析：

sh
docker run -it --rm --pull=always -e FRUGGR_API_KEY={FRUGGR_API_KEY} docker.xuanyuan.run/fruggr/scanner:latest

参数说明

• --pull=always：确保拉取最新版本镜像
• --rm：容器退出后自动清理
• -e FRUGGR_API_KEY：设置必填的 API 密钥环境变量（替换 {FRUGGR_API_KEY} 为实际密钥）
• 推荐使用 latest 标签以获取最新分析能力

GitLab CI/CD 集成

在 GitLab 流水线中配置自动分析（以 main 分支推送为例）：

yml
fruggr-scanner:
  image: docker.xuanyuan.run/fruggr/scanner:latest
  allow_failure: true  # 不阻断流水线执行
  variables:
    FRUGGR_API_KEY: '${FRUGGR_API_KEY}'  # 引用项目 CI/CD 变量
  script:
    - fruggr  # 执行分析命令
  only:
    - main  # 仅在 main 分支触发

配置步骤

1. 在 GitLab 项目中添加 CI/CD 变量：进入 设置 > CI/CD > 变量，添加 FRUGGR_API_KEY 并存储实际密钥
2. 将上述配置添加到项目根目录的 .gitlab-ci.yml 文件中

环境变量配置

通用配置

Git 仓库配置

当需要从 Git 仓库拉取代码进行分析时，需配置以下变量：

认证配置

用于访问受保护资源的环境变量（根据目标服务认证方式选择配置）：

配置示例

console
FRUGGR_AUTH_FORM_URL='[***]
FRUGGR_AUTH_FORM_SUBMIT_SELECTOR='button[type="submit"]'
FRUGGR_AUTH_HEADERS='{"Authorization":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."}'