themarshallproject/klaxon

Klaxon：网站变化监控工具

镜像概述和主要用途

Klaxon是一款免费、开源的网站变化监控工具，由非营利调查新闻机构The Marshall Project在新闻编辑室开发并优化。它能定期检查用户指定的网页内容，当检测到变化时，通过邮件、Slack或***通知用户具体变更，帮助记者及时发现新闻线索，节省手动刷新网页的时间。该工具的公开版本由Knight-Mozilla OpenNews支持，已被《纽约时报》《德克萨斯论坛报》等多家新闻机构使用。

核心功能和特性

• 网页变化监控：支持"书签"网页特定部分，仅追踪用户关注的内容区域
• 多渠道通知：可通过邮件、Slack和***发送变更提醒
• 易于部署：支持Heroku快速部署，也可通过Docker或Linux服务器搭建
• 用户管理：支持添加多个用户，管理员可配置权限和集成服务
• 灵活配置：可限制仅特定***域名用户注册，保护新闻室数据安全
• 开源免费：代码完全开源，允许新闻机构根据需求自定义和扩展功能

使用场景和适用范围

Klaxon特别适合以下场景：

• 新闻编辑室监控***信息披露日志、法庭记录、政策文件等关键公共信息
• 追踪特定人物相关内容（如***人物动态）
• 监控企业公告、产品更新或行业报告的变化
• 任何需要定期检查网页但希望避免手动刷新的场景

详细使用方法和配置说明

部署选项

Klaxon提供多种部署方式，推荐新闻编辑室使用Heroku快速部署，也可选择Docker或Linux服务器部署（具体Docker部署文档可参考项目https://github.com/themarshallproject/klaxon/blob/develop/DOCKER.md%EF%BC%89%E3%80%82

Heroku快速部署

1. 准备工作：

   • 注册Heroku账户
   • 点击部署按钮：![Deploy]([***]

2. 配置应用：

   • 输入应用名称（将作为访问URL，如newsroom-klaxon.herokuapp.com）
   • 在Admin_emails字段填写管理员***（逗号分隔多个***）
   • 点击"Deploy for Free"按钮，等待应用构建

3. 设置调度器：

   • 进入Heroku应用"Resources"标签，找到"Heroku Scheduler"并点击
   • 添加新任务，命令填写rake check:all，频率设置为"Every 10 minutes"
   • 保存任务（此步骤确保每10分钟检查一次监控的网站）

4. 配置SendGrid邮件服务：

   • 进入Heroku应用"Resources"标签，点击"Sendgrid"插件
   • 在SendGrid控制台创建API密钥（选择"Full Access"权限）
   • 返回Heroku"Settings"标签，点击"Reveal Config Vars"：
     • 将SENDGRID_USERNAME设为apikey
     • 将SENDGRID_PASSWORD设为创建的API密钥
   • 在SendGrid配置"Verified Sender"，并将Heroku的MAILER_FROM_ADDRESS变量设为该

用户管理

1. 管理员登录：

   • 部署完成后，访问应用URL，输入管理员***点击"Login"
   • 查收登录邮件，点击"Go to Dashboard"进入系统

2. 添加用户：

   • 点击右上角"Settings"，选择"Users"
   • 点击"Create New User"，输入用户姓名和***，系统将发送邀请邮件

3. 限制用户域名（可选）：

   • 设置环境变量APPROVED_USER_DOMAINS（如themarshallproject.org,nytimes.com）
   • 仅允许指定域名的***注册

Slack/***集成

Slack配置

1. 在Slack工作区创建"Incoming Webhooks"集成：

   • 进入"Apps & Integrations"，搜索"Incoming Webhooks"
   • 选择目标频道（建议创建专用#klaxon频道）
   • 复制生成的Webhook URL

2. 在Klaxon中添加Slack集成：

   • 点击"Settings" > "Integrations" > "Create Slack Integration"
   • 粘贴Webhook URL，输入频道名称，保存配置

***配置

1. 在***服务器创建Webhook：

   • 进入"Server Settings" > "Integrations" > "Create Webhook"
   • 选择目标频道，复制Webhook URL
   • 重要：在URL末尾添加/slack（使其兼容Slack格式）

2. 在Klaxon中添加***集成：

   • 同Slack集成步骤，粘贴修改后的Webhook URL和频道名称

升级方法

当项目发布更新时，可通过以下步骤升级：

1. Fork项目仓库：

   • 在https://github.com/themarshallproject/klaxon%E7%82%B9%E5%87%BB%22Fork%22%EF%BC%8C%E5%A4%8D%E5%88%B6%E4%BB%A3%E7%A0%81%E5%88%B0%E4%B8%AA%E4%BA%BA%E8%B4%A6%E5%8F%B7

2. 配置Heroku自动部署：

   • 进入Heroku应用"Deploy"标签，选择"Github"作为部署方式
   • 连接Fork的仓库，启用"Automatic Deploys"（选择master分支）

3. 合并更新：

   • 在个人Github仓库点击"New Pull Request"
   • 选择"compare across forks"，将marshallproject/klaxon的master分支合并到个人仓库
   • 确认合并后，Heroku将自动部署更新

成本说明

• Heroku免费层：包含12,000封/月SendGrid邮件、10,000条数据库记录、18小时/天服务可用时间
• 可选升级：
  • SendGrid升级：$9.95/月可发送40,000封邮件
  • 数据库升级：$9/月可存储1000万条记录
  • Heroku Dyno升级：$7/月可实现24小时服务可用

注意事项

• SendGrid账户需要通过反垃圾邮件验证，否则无法发送登录邮件（通常几小时内完成）
• 作为开源项目，可能存在偶发bug，建议定期备份数据
• 鼓励通过https://github.com/themarshallproject/klaxon/issues%E6%8F%90%E4%BA%A4%E5%8F%8D%E9%A6%88%E6%88%96%E8%B4%A1%E7%8C%AE%E4%BB%A3%E7%A0%81

社区支持

• 用户交流：Google Group邮件列表
• 贡献指南：https://github.com/themarshallproject/klaxon/blob/master/CONTRIBUTING.md