bahmniindiadistro/hip-atomfeed

hip-atomfeed listener 镜像文档

镜像概述

hip-atomfeed listener镜像基于轻量级基础镜像构建，专门设计用于监听Atom Feed源，实现对Atom格式数据的实时接收、解析与处理。该镜像提供了便捷的配置方式，支持自定义Feed源地址、轮询间隔等参数，适用于各类需要实时获取和处理Atom Feed信息的应用场景。

核心功能与特性

• 实时监听Atom Feed：支持指定一个或多个Atom Feed源地址，定时轮询获取最新数据
• 数据解析处理：内置Atom格式解析器，可自动解析Feed中的条目（entry）信息（如标题、链接、发布时间等）
• 灵活配置：支持通过环境变量或配置文件自定义Feed源、轮询间隔、日志级别等参数
• 轻量级设计：基于精简基础镜像，镜像体积小，资源占用低，部署便捷
• 错误处理机制：具备基本的错误重试和日志记录功能，确保数据处理的可靠性

使用场景与适用范围

• 数据同步：用于同步外部系统发布的Atom Feed数据到本地应用或数据库
• 消息集成：作为中间件接收Atom格式的消息，转发至后续处理系统（如消息队列、业务服务）
• 内容聚合：聚合多个Atom Feed源的内容，生成统一的数据视图
• 实时通知：监听特定Feed源，当有新条目发布时触发通知或后续处理流程

使用方法与配置说明

快速部署（docker run）

通过以下命令快速启动容器，监听指定的Atom Feed源：

bash
docker run -d \
  --name hip-atomfeed-listener \
  -e FEED_URL="https://example.com/feed.atom" \
  -e POLL_INTERVAL=60 \
  -e LOG_LEVEL=info \
  hip-atomfeed-listener:latest

docker-compose配置示例

使用docker-compose管理容器，支持多Feed源配置：

yaml
version: '3'
services:
  hip-atomfeed-listener:
    image: hip-atomfeed-listener:latest
    container_name: hip-atomfeed-listener
    environment:
      - FEED_URL=https://example.com/feed.atom,https://another-example.com/feed.atom  # 多个Feed源用逗号分隔
      - POLL_INTERVAL=30  # 轮询间隔，单位秒，默认60
      - LOG_LEVEL=debug  # 日志级别：debug, info, warn, error，默认info
      - TIMEOUT=10  # 请求超时时间，单位秒，默认5
      - PROXY_URL=http://proxy:8080  # 可选，代理服务器地址
    restart: unless-stopped

配置参数说明

数据处理方式

默认情况下，监听到的Atom Feed条目会通过标准输出打印，格式为JSON。用户可通过以下方式自定义处理逻辑：

1. 挂载自定义处理脚本到容器/app/handler目录（需确保脚本可执行）
2. 脚本接收解析后的JSON数据作为输入，可实现数据存储、转发等自定义操作

示例自定义脚本（handler.sh）：

bash
#!/bin/sh
read data
# 将数据写入文件
echo "$data" >> /data/atom_feed_entries.log
# 或转发至消息队列（需容器内安装对应客户端）

挂载命令：

bash
docker run -d \
  --name hip-atomfeed-listener \
  -e FEED_URL="[***]" \
  -v ./handler.sh:/app/handler/handler.sh \
  -v ./data:/data \
  hip-atomfeed-listener:latest