texastribune/tt-rss-to-json

RSS to JSON 镜像文档

镜像概述和主要用途

该镜像用于将摘要RSS订阅源转换为可用的JSON格式，并将转换后的文件推送到Amazon S3存储。作为德克萨斯论坛报（The Texas Tribune）API更新期间的临时解决方案，它提供了一种快速将RSS数据转换为结构化JSON并进行存储的机制。

核心功能和特性

• RSS到JSON转换：自动解析指定的RSS订阅源，将其内容转换为结构化的JSON格式
• S3集成：支持将转换后的JSON文件直接推送到Amazon S3存储桶
• 灵活配置：通过环境变量配置AWS凭据和S3存储桶信息
• 可定制源列表：通过修改source.js文件自定义需要拉取的RSS订阅源

使用场景和适用范围

• 作为API服务中断或更新期间的临时数据转换方案
• 需要将RSS格式数据转换为JSON格式进行进一步处理或存储的场景
• 小规模RSS数据同步和备份需求

使用方法和配置说明

环境准备

需配置以下环境变量：

• AWS_ACCESS_KEY_ID：AWS访问密钥ID（具备S3写入权限）
• AWS_SECRET_ACCESS_KEY：AWS密钥
• AWS_S3_BUCKET：目标S3存储桶名称

非Docker环境使用

1. 安装依赖

   sh
   npm install
   

2. 配置AWS凭据
   可通过以下方式之一配置（推荐使用环境变量）：

   • 设置环境变量（AWS_ACCESS_KEY_ID和AWS_SECRET_ACCESS_KEY）
   • 创建~/.aws/credentials文件（遵循AWS SDK标准配置）

3. 配置S3存储桶
   设置环境变量指定目标S3存储桶：

   sh
   export AWS_S3_BUCKET=your-bucket-name
   

4. 自定义RSS源
   编辑source.js文件，添加或修改需要拉取的RSS订阅源列表

5. 运行转换程序

   sh
   npm start
   

Docker环境使用

构建镜像

使用Make命令构建Docker镜像：

sh
make docker/build

运行容器

方式一：通过环境变量文件
创建环境变量文件（如env-docker），包含以下内容：

AWS_ACCESS_KEY_ID=your-access-key
AWS_SECRET_ACCESS_KEY=your-secret-key
AWS_S3_BUCKET=your-bucket-name

运行容器：

sh
docker run -it --rm --env-file=env-docker rsstojson

方式二：直接传递环境变量
运行容器时直接指定环境变量：

sh
docker run -it --rm \
  --env AWS_ACCESS_KEY_ID=your-access-key \
  --env AWS_SECRET_ACCESS_KEY=your-secret-key \
  --env AWS_S3_BUCKET=your-bucket-name \
  rsstojson

注意事项

• 确保AWS凭据具有目标S3存储桶的写入权限
• source.js文件中定义的RSS源需可公开访问或已配置相应访问权限
• 容器运行后会立即执行转换并推送操作，完成后自动退出