reader

环境要求

• 已安装 Docker，可运行 docker pull / docker run
• 主机能访问 GitHub Container Registry（ghcr.io）
• 仅使用公共 API 时无需安装，只要能访问 r.jina.ai 和 s.jina.ai
• 若要启用桶缓存，需要有一个 S3 兼容的对象存储桶

安装与启动步骤

1. 1调用公共 Read 接口

   在任意公开网页 URL 前加上 https://r.jina.ai/ 前缀，即可拿到清洗后的 LLM 友好输入（Markdown）。免费、无需注册。

   curl https://r.jina.ai/https://github.com/jina-ai/reader

   复制

2. 2调用公共 Search 接口

   把查询词拼在 https://s.jina.ai/ 后面，即可让模型检索到最新的网络信息。空格等特殊字符需转义。

   curl "https://s.jina.ai/Who%20will%20win%202024%20US%20presidential%20election%3F"

   复制

3. 3拉取自托管镜像

   开源分支的预构建镜像已发布到 ghcr.io，内置 headless Chrome、LibreOffice 和 CJK 字体，无需自行构建。

   docker pull ghcr.io/jina-ai/reader:oss

   复制

4. 4启动容器

   镜像暴露 8080（h2c）和 8081（HTTP/1.1）两个端口。用 curl 或浏览器测试时映射 HTTP/1.1 的 8081。

   docker run --rm -p 3000:8081 ghcr.io/jina-ai/reader:oss

   复制

5. 5带缓存启动

   指向一个 S3 兼容存储桶后，抓取过的页面会被缓存，多次请求之间复用，减少重复抓取。

   docker run --rm -p 3000:8081 \
     -e GCP_STORAGE_ENDPOINT=https://s3.example.com \
     -e GCP_STORAGE_BUCKET=reader-cache \
     -e GCP_STORAGE_ACCESS_KEY=your-access-key \
     -e GCP_STORAGE_SECRET_KEY=your-secret-key \
     ghcr.io/jina-ai/reader:oss

   复制

6. 6查阅环境变量表

   镜像支持的其他环境变量未在 README 正文列出，需按 README 指引查看 CONTRIBUTING.md 中的完整环境变量表。

   git clone https://github.com/jina-ai/reader.git

   复制

关键配置

如何确认成功

容器启动后，用 curl 或浏览器访问 http://localhost:3000 有正常响应即成功；公共接口可先验证 r.jina.ai 前缀链接是否返回内容。

常见问题

注意事项

• 开源分支默认以无状态模式开箱运行，如需缓存可选用 MinIO/S3 兼容桶，通过 docker compose 或环境变量配置。
• README 的 Usage 章节为空，本地开发（local development）细节未在节选中给出，需自行查看仓库中的 CONTRIBUTING.md。
• 全部环境变量的完整表格见 CONTRIBUTING.md 的 environment-variables 小节。
• 公共 API 有速率限制，生产使用前建议先了解官网定价页的限额说明。