Omnivore

Omnivore 是一款面向文本爱好者的完整开源稍后阅读解决方案。

[!IMPORTANT] Omnivore 现已成为完全自托管（Self-Hosted）应用。云应用已于2024年11月停止维护。社区仍在***上活跃，我们将持续进行更新和错误修复。

我们开发Omnivore是因为我们热爱阅读，并希望让阅读更具社交性。加入我们吧！

• 高亮、笔记、搜索与分享
• 全键盘导航
• 自动保存长文章阅读进度
• 通过电子邮件添加新闻通讯文章（支持Substack！）
• PDF支持
• Web应用 使用Node.js和TypeScript编写
• 原生iOS应用（https://github.com/omnivore-app/omnivore/tree/main/apple%EF%BC%89
• Android应用（https://github.com/omnivore-app/omnivore/tree/main/android/Omnivore%EF%BC%89
• 面向Android用户的渐进式Web应用（PWA）
• 标签（Labels）功能
• 离线支持
• 文本转语音（仅iOS）
• 通过https://github.com/omnivore-app/logseq-omnivore%E6%94%AF%E6%8C%81Logseq
• 通过https://github.com/omnivore-app/obsidian-omnivore%E6%94%AF%E6%8C%81Obsidian

所有组件均完全开源！您可以 Fork 项目、扩展功能或部署到自己的服务器。

自托管服务器运行指南可参见此处

加入我们的***社区！:speech_balloon:

我们正在***上构建社区。立即加入！

在我们的博客上了解更多关于Omnivore的信息。

鸣谢 :tada:

Omnivore借鉴了许多优秀的开源软件：

• TypeScript - 我们的大部分后端和前端均使用TypeScript编写。
• Next.js - 前端基于Next.JS构建，并托管于Vercel。
• SWR - Web端数据获取均使用SWR实现。
• Stitches - 前端组件样式采用Stitches。
• https://github.com/mozilla/readability - 使用Mozilla的Readability库优化页面可读性。
• Swift GraphQL - iOS端通过Swift GraphQL生成GraphQL查询。
• Apollo GraphQL - Android端通过Apollo GraphQL生成GraphQL查询。
• Radix - 前端使用Radix UI组件。
• https://github.com/mozilla/pdf.js - 采用PDF.js实现开源PDF功能。
• 以及更多优秀的库，可查看我们的包文件了解详细依赖。

社区鸣谢 🧑‍🤝‍🧑

• https://github.com/Poudlardo - 提供了用于自托管的Podman-compose文件。
• https://github.com/leopku - 修复了v3清单的构建问题。
• https://github.com/travisemslander-fn - 提供了SNS邮件相关修复。
• https://github.com/andrew-craig 与 https://github.com/lukebtaylor - 提供了邮件功能修复。
• https://github.com/Benature - 提供了Minio相关修复。
• https://github.com/rbarbazz - 实现了笔记的HTML切换功能。
• https://github.com/pgrosslicht - iOS应用的多项修复。
• https://github.com/omnivore-app/omnivore/commit/4e582fb55db5537a462061c9eb0805b482cc9a00 - 参与了自托管功能的初始提交（因提交压缩导致历史记录丢失）。
• ***用户mollydot - 持续参与社区 moderation并积极活跃。

当然，还有...

以及许多过去的贡献者。如果您认为自己的名字应出现在此列表中，请通过***联系我（Podginator）。

数据导入

有关从其他应用导入数据的信息，请参见我们的文档。

本地开发环境设置 :computer:

开始本地开发的最简单方法是使用docker compose up。这将启动postgres容器、Web前端、API服务器以及内容抓取微服务。

开发环境要求

Omnivore使用TypeScript和JavaScript编写。

• Chromium — 安装信息见下文。

运行Web和API服务

1. 启动docker compose

git clone https://github.com/omnivore-app/omnivore
cd omnivore
docker compose up

此命令将启动postgres、初始化数据库并启动Web和API服务。

2. 打开浏览器

打开浏览器并确认Omnivore已运行。

3. 使用测试账户登录

数据库设置期间，docker compose会创建测试账户demo@omnivore.work，密码：demo_password。

在浏览器中访问应用，选择“Continue with Email”进行登录。

前端开发

如果只需开发Omnivore前端，可通过docker compose运行后端服务，同时在本地运行前端：

docker compose up api content-fetch
cd packages/web
cp .env.template .env.local
yarn dev

需在新创建的.env.local文件中配置以下值，用于在本地主机直接运行web服务，并在docker中运行api和content-fetch：

NEXT_PUBLIC_BASE_URL=http://localhost:3000
NEXT_PUBLIC_HIGHLIGHTS_BASE_URL=http://localhost:3000
NEXT_PUBLIC_LOCAL_BASE_URL=http://localhost:3000
NEXT_PUBLIC_SERVER_BASE_URL=http://localhost:4000
NEXT_PUBLIC_LOCAL_SERVER_BASE_URL=http://localhost:4000

在Docker外部运行puppeteer-parse服务

要保存页面，需运行puppeteer-parse服务。

1. 安装并配置Chromium

brew install chromium --no-quarantine
export PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=true
export CHROMIUM_PATH=`which chromium`

2. 导航至服务目录，设置环境文件并安装依赖

cd packages/puppeteer-parse
cp .env.example .env
yarn

3. 启动服务

yarn start

此命令将在端口9090启动puppeteer-parse服务。

在浏览器中访问应用，点击“Add Link”按钮，输入URL（例如https://blog.omnivore.work/p/getting-started-with-omnivore）。

此时会打开Chromium窗口并导航至该链接。服务完成内容抓取后，您将在库中看到该内容。

部署到自有服务器

自托管服务器运行指南可参见此处

许可证

Omnivore及其对Readability.js的扩展均采用AGPL-3.0许可证。