首页
/ Tiny Tiny RSS 技术文档

Tiny Tiny RSS 技术文档

2024-12-20 10:37:40作者:毕习沙Eudora

1. 安装指南

环境要求

在安装 Tiny Tiny RSS 之前,请确保您的系统满足以下要求:

  • 兼容的 Web 浏览器(请参考:兼容浏览器列表
  • Web 服务器,例如 Apache
  • PHP(需要支持 mbstring 函数)
  • PostgreSQL(经过 8.3 版本测试)或 MySQL(需要 InnoDB 支持,版本 4.1 或更高)

安装步骤

  1. 下载 Tiny Tiny RSS 源代码。
  2. 将源代码上传到您的 Web 服务器。
  3. 设置数据库:根据您选择的数据库类型(PostgreSQL 或 MySQL),创建一个新的数据库,并赋予适当的权限。
  4. 修改配置文件 config.php,设置数据库连接信息。
  5. 通过 Web 浏览器访问安装向导,完成剩余的安装步骤。

更多安装细节和常见问题,请参考:安装说明

2. 项目的使用说明

Tiny Tiny RSS 是一个基于 Web 的新闻聚合器,允许您从任何位置阅读新闻,并提供接近桌面应用的用户体验。

功能特点

  • 自托管:控制您自己的数据,保护隐私,无需依赖第三方服务。
  • 支持新闻源聚合/分发。
  • 支持键盘快捷键。
  • 支持 OPML 导入/导出。
  • 多种分享方式:导出 RSS 订阅、插件支持各类社交网站、通过 URL 分享等。
  • 插件和主题支持。
  • 通过可读性和特定网站插件嵌入完整文章内容。
  • 文章过滤。
  • JSON API。

3. 项目API使用文档

Tiny Tiny RSS 提供了 JSON API,用于与其他应用程序或服务进行交互。以下是一些基本的 API 使用方法:

获取新闻源列表

GET /api/index.php?op=getFeeds

添加新闻源

POST /api/index.php?op=addFeed

更新新闻源

POST /api/index.php?op=updateFeed

删除新闻源

POST /api/index.php?op=removeFeed

更多 API 文档和示例,请参考项目官方文档。

4. 项目安装方式

Docker 安装

如果您的环境支持 Docker,可以使用以下命令安装 Tiny Tiny RSS:

docker run -d --name tinytinyrss -p 80:80 -v /path/to/data:/data tt-rss

手动安装

  1. 从官方网站下载 Tiny Tiny RSS 源代码。
  2. 将下载的源代码上传到您的 Web 服务器。
  3. 根据您的数据库类型创建数据库,并设置适当的权限。
  4. 修改配置文件 config.php,配置数据库连接信息。
  5. 通过 Web 浏览器访问安装向导,完成安装。

请确保在安装过程中遵循官方文档的指导,以确保安装成功。

登录后查看全文
热门项目推荐