phpdockerio/readability-js-server

Readability JS server

镜像概述和主要用途

本镜像将https://github.com/mozilla/readability%E5%B0%81%E8%A3%85%E4%B8%BAHTTP%E6%9C%8D%E5%8A%A1%EF%BC%8C%E5%8F%AF%E9%80%9A%E8%BF%87Docker%E5%9C%A8%E4%BB%BB%E4%BD%95%E7%8E%AF%E5%A2%83%E9%83%A8%E7%BD%B2%E3%80%82%E5%AE%83%E6%8F%90%E4%BE%9B%E7%AE%80%E5%8D%95%E7%9A%84API%E6%8E%A5%E5%8F%A3%EF%BC%8C%E6%8E%A5%E6%94%B6%E7%BD%91%E9%A1%B5URL%E5%B9%B6%E8%BF%94%E5%9B%9E%E6%8F%90%E5%8F%96%E7%9A%84%E6%A0%B8%E5%BF%83%E5%86%85%E5%AE%B9%EF%BC%8C%E9%80%82%E7%94%A8%E4%BA%8E%E9%9C%80%E8%A6%81%E4%BB%8E%E7%BD%91%E9%A1%B5%E4%B8%AD%E6%8F%90%E5%8F%96%E7%BB%93%E6%9E%84%E5%8C%96%E5%86%85%E5%AE%B9%E7%9A%84%E5%9C%BA%E6%99%AF%E3%80%82

核心功能和特性

• 简单API：仅提供一个HTTP端点，通过JSON格式交互
• 内容提取：接收网页URL，返回包含页面核心内容的JSON响应
• 易于部署：Docker化封装，无需复杂配置即可运行
• 版本控制：遵循Semver版本规范，提供多种标签选择

使用场景和适用范围

• 内容聚合应用：提取网页主要内容用于展示
• 阅读工具：为应用提供网页内容解析能力
• 数据采集：从网页中提取结构化信息
• 任何需要快速获取网页核心内容的服务集成

使用方法和配置说明

查询接口

服务提供唯一的HTTP端点，通过POST请求提交JSON格式数据，包含需要提取内容的URL。

请求示例

bash
curl -XPOST http://readability-js-server:3000/ \
    -H "Content-Type: application/json" \
    -d'{"url": "https://en.wikipedia.org/wiki/Firefox"}'

响应示例

HTTP/1.1 200 OK
X-Powered-By: Express
Content-Type: application/json; charset=utf-8
{
   "url": "https://en.wikipedia.org/wiki/Firefox",
   "content": "<div id=\"readability-page-1\" class=\"page\"> [...]"
   "excerpt": "Firefox 65 (Quantum) running on Arch Linux with KDE Plasma 5",
}

Docker部署

镜像信息

• 镜像地址：phpdockerio/readability-js-server
• 端口：3000（容器内部固定端口）

版本控制

镜像标签遵循Semver规范，提供以下标签：

• latest：最新版本
• x.x.x：完整版本号（如1.2.3）
• x.x：主版本.次版本（如1.2）
• x：主版本（如1）

建议根据稳定性需求选择标签，例如使用phpdockerio/readability-js-server:1可确保无破坏性更新。

部署示例

bash
docker run -p 3000:3000 phpdockerio/readability-js-server

本地运行

如需本地开发或测试，需满足以下环境要求：

• Node.js >= 10
• yarn包管理器

运行步骤

1. 克隆代码仓库
2. 安装依赖：

   bash
   yarn install
   

3. 启动服务：

   bash
   yarn start
   

注意事项

• 无配置需求：当前版本无需额外配置，直接运行即可
• Node版本依赖：依赖Node.js 10，这是由于yarn.lock文件是基于该版本创建的，部分依赖可能需要此版本
• Docker运行配置：Docker镜像使用pm2管理进程，默认启动5个Node.js进程，目前不可配置
• 兼容性：如需在低版本Node.js（如Node 8）环境运行，可删除yarn.lock后重新安装依赖