Selfoss 2.20-SNAPSHOT 技术文档

1. 安装指南

1.1 下载

• 稳定版本: 访问 GitHub Releases 页面下载最新稳定版本。
• 开发版本: 如果你想尝试未发布的功能或修复，可以访问 Cloudsmith 下载开发版本。
• 源代码: 如果你想参与开发，可以通过 Git 克隆源代码仓库：git clone https://github.com/fossar/selfoss.git。

1.2 安装步骤

1. 上传文件: 将项目目录中的所有文件上传到你的服务器（包括隐藏的 .htaccess 文件）。
2. 设置写权限: 确保 data/cache、data/favicons、data/logs、data/thumbnails 和 data/sqlite 目录具有写权限。
3. 配置数据库: 编辑 config.ini 文件，填写数据库访问信息。如果你使用 SQLite，则无需更改任何内容。
4. 自动创建数据库表: 数据库表将自动创建（确保你的数据库用户有权限创建触发器）。
5. 设置定时任务: 创建一个 cronjob 或 systemd 定时器，用于更新订阅源，指向 https://yourselfossurl.com/update，使用 wget 或 curl 执行。

1.3 开发环境安装

如果你通过 Git 获取了源代码，还需要执行以下步骤：

1. 安装依赖: 使用 composer install 安装 PHP 依赖，使用 npm install 安装 JavaScript 依赖。
2. 构建客户端: 运行 npm run build 构建客户端代码，或使用 npm run dev 进行开发。

2. 项目使用说明

2.1 基本使用

• 添加订阅源: 你可以通过界面添加 RSS 或其他类型的订阅源，selfoss 会自动聚合这些订阅源的内容。
• 查看更新: 在主界面查看所有订阅源的最新更新。
• OPML 导入: 支持从其他 RSS 阅读器导入 OPML 文件，访问 https://yourselfossurl.com/opml 上传文件。

2.2 配置

• 自定义设置: 你可以通过编辑 config.ini 文件来自定义 selfoss 的设置，删除不需要覆盖的行。
• 更新配置: 在升级版本时，确保更新 config.ini 文件以包含新版本中的新选项。

3. 项目API使用文档

selfoss 提供了一些 API 接口，允许你通过编程方式与应用进行交互。以下是一些常用的 API 接口：

3.1 获取订阅源列表

GET /sources

返回所有订阅源的列表。

3.2 添加订阅源

POST /sources

通过 POST 请求添加新的订阅源，请求体中需要包含订阅源的 URL 和其他相关信息。

3.3 获取文章列表

GET /items

返回所有文章的列表，可以通过参数过滤文章的状态（如已读、未读）。

3.4 标记文章为已读

POST /items/mark

通过 POST 请求标记文章为已读，请求体中需要包含文章的 ID。

4. 项目安装方式

selfoss 可以通过以下几种方式安装：

1. 直接下载: 从 GitHub Releases 页面下载稳定版本，解压后上传到服务器。
2. Git 克隆: 通过 Git 克隆源代码仓库，然后安装依赖并构建项目。
3. 开发版本: 从 Cloudsmith 下载开发版本，适合想要尝试最新功能的用户。

通过以上步骤，你可以顺利安装并使用 selfoss，享受多功能的 RSS 阅读和订阅聚合服务。