commafeed

逗号提要

Google Reader 启发了自托管 RSS 阅读器，基于 Quarkus 和 React/TypeScript。

特征

• 4种不同的布局
• 浅色/深色主题
• 完全响应式，在移动设备和桌面设备上都能很好地工作
• 几乎所有内容的键盘快捷键
• 支持从右到左提要
• 翻译成超过 25 种语言
• 支持数千名用户和数百万个提要
• OPML 导入/导出
• 休息API
• 适用于本机移动应用程序的 Fever 兼容 API
• 可以根据用户定义的规则自动将文章标记为已读
• 浏览器扩展
• 编译为本机代码，实现极快的启动速度和低内存使用率
• 支持4个数据库
  • H2（嵌入式数据库）
  • PostgreSQL
  • MySQL
  • 玛丽亚数据库

部署

码头工人

Docker 是开始使用 CommaFeed 的最简单方法。

Docker 镜像是自动构建的，可从 https://hub.docker.com/r/athou/commafeed 获取

云托管

PikaPods 提供一键式云托管解决方案，起价为每月 1 美元，并提供 5 美元的免费欢迎积分，并正式支持 CommaFeed。 PikaPods 将 20% 的收入分享给 CommaFeed。

下载预编译包

转到发行页面并下载适合您选择的操作系统和数据库的最新版本。

有两种类型的包：

• linux-x86_64和windows-x86_64软件包是本机编译的，并且包含可以直接运行的可执行文件。
• jvm包是一个 zip 文件，其中包含运行应用程序所需的所有.jar文件。该包适用于所有平台，并以java -jar quarkus-run.jar启动。

如果您的操作系统可用，建议使用本机包，因为它具有更快的启动时间和更低的内存使用量。

从源头构建

 ./mvnw clean package [-P<database>] [-Pnative] [-DskipTests]

• <database>可以是h2 、 postgresql 、 mysql或mariadb之一。默认为h2 。
• -Pnative将应用程序编译为本机代码。这需要安装 GraalVM（ GRAALVM_HOME环境变量指向 GraalVM 安装）。
• -DskipTests通过跳过测试来加速构建过程。

构建完成后：

• 包含运行应用程序所需的所有 jar 的 zip 位于commafeed-server/target/commafeed-<version>-<database>-jvm.zip 。解压它并使用java -jar quarkus-run.jar运行应用程序
• 如果您使用本机配置文件，则可执行文件位于commafeed-server/target/commafeed-<version>-<database>-<platform>-<arch>-runner[.exe]

配置

CommaFeed 不需要任何配置即可与其嵌入式数据库 (H2) 一起运行。数据库文件将存放在当前目录的data目录下。

要使用不同的数据库，您需要配置以下属性：

• quarkus.datasource.jdbc.url
  • 例如对于 H2： jdbc:h2:./data/db;DEFRAG_ALWAYS=TRUE
  • 例如对于 PostgreSQL： jdbc:postgresql://localhost:5432/commafeed
  • 例如对于 MySQL： jdbc:mysql://localhost/commafeed?autoReconnect=true&failOverReadOnly=false&maxReconnects=20&rewriteBatchedStatements=true&timezone=UTC
  • 例如对于 MariaDB： jdbc:mariadb://localhost/commafeed?autoReconnect=true&failOverReadOnly=false&maxReconnects=20&rewriteBatchedStatements=true&timezone=UTC
• quarkus.datasource.username
• quarkus.datasource.password

配置 CommaFeed 的方法有多种：

• 相对于工作目录的config/application.properties属性文件（短横线大小写的键）
• 命令行参数以-D为前缀（短横线大小写的键）
• 环境变量（大写字母）
• 工作目录中的.env文件（大写字母）

建议使用属性文件，因为 CommaFeed 将能够警告无效属性和拼写错误。

所有 CommaFeed 设置都是可选的，并且具有合理的默认值。

登录时，凭据存储在加密的 cookie 中。加密密钥是在启动时随机生成的，这意味着您每次重新启动应用程序后都必须重新登录。为了防止这种情况，您可以将quarkus.http.auth.session.encryption-key属性设置为固定值（最少 16 个字符）。所有其他 Quarkus 设置都可以在此处找到。

启动后，服务器将侦听 http://localhost:8082。默认用户是admin ，默认密码是admin 。

更新

当 CommaFeed 启动并运行时，您可以订阅此源以获取新版本的通知。

内存管理

Java 虚拟机 (JVM) 默认情况下相当贪婪，不会将未使用的内存释放给操作系统。这是因为从操作系统获取内存是一个相对昂贵的操作。这在内存有限的系统上可能会出现问题。

硬限制（ native和jvm包）

可以使用-Xmx参数将 JVM 配置为使用最大内存量。例如，要将 JVM 内存限制为 256MB，请使用-Xmx256m 。

动态调整大小（ jvm包）

除了前面的设置之外，还可以使用以下参数配置 JVM 将未使用的内存释放给操作系统：

 -Xms20m -XX:+UseG1GC -XX:+UseStringDeduplication -XX:-ShrinkHeapInSteps -XX:G1PeriodicGCInterval=10000 -XX:-G1PeriodicGCInvokesConcurrent -XX:MinHeapFreeRatio=5 -XX:MaxHeapFreeRatio=10

请参阅此处和此处了解更多信息。

OpenJ9（ jvm包）

OpenJ9 JVM 是 HotSpot JVM 的内存效率更高的替代方案，但代价是吞吐量稍慢。

IBM 为 OpenJ9 提供了名为 Semeru 的预编译二进制文件。这是 Docker 镜像中使用的 JVM。

翻译

国际化文件位于此处。

添加新语言：

• 将新区域设置添加到locales数组中：
  • commafeed-client/.linguirc
  • commafeed-client/src/i18n.ts
• 运行npm run i18n:extract
• 将翻译添加到新创建的commafeed-client/src/locales/[locale]/messages.po文件

区域设置的名称应该是两个字母的 ISO-639-1 语言代码。

当地发展

后端

• 在您首选的 Java IDE 中打开commafeed-server 。
  • CommaFeed 使用 Lombok，您的 IDE 需要 Lombok 插件。
• 运行./mvnw quarkus:dev

前端

• 在您首选的 JavaScript IDE 中打开commafeed-client 。
• 运行npm install
• 运行npm run dev

前端服务器现在在 http://localhost:8082 上运行，并将 REST 请求代理到在端口 8083 上运行的后端