FreshRSS README

The project's README from github.com/FreshRSS/FreshRSS. As one markdown file: README.md.

Liberapay donations

FreshRSS

FreshRSS is a self-hosted RSS feed aggregator.

It is lightweight, easy to work with, powerful, customizable, and has been translated into many languages.

It is a multi-user application with an anonymous reading mode. It supports custom tags. There is an API for (mobile) clients, and a Command-Line Interface.

Thanks to the WebSub standard, FreshRSS is able to receive instant push notifications from compatible sources, such as Friendica, WordPress, Blogger, Medium, etc.

FreshRSS natively supports basic Web scraping, based on XPath, for Web sites not providing any RSS / Atom feed. Also supports JSON documents.

FreshRSS offers the ability to reshare selections of articles by HTML, RSS, and OPML.

Different login methods are supported: Web form (including an anonymous option), HTTP Authentication (compatible with proxy delegation), OpenID Connect.

Finally, FreshRSS supports extensions for further tuning.

FreshRSS logo

Feedback and contributions

Feature requests, bug reports, and other contributions are welcome. The best way is to open an issue on GitHub. We are a friendly community.

To facilitate contributions, the following option is available:

Open in GitHub Codespaces

Screenshot

FreshRSS screenshot

Disclaimer

FreshRSS comes with absolutely no warranty.

Documentation

Requirements

Installation

If you want a rolling release with the newest features and security fixes, or want to help testing or developing the next release, you can use the edge branch.

If you prefer fewer updates, you can use the latest branch. It is more stable but at the price of less security and more known bugs, as fixes are not backported to older versions. New versions are published a few times a year. See the latest release and the list of releases.

Automated install

Docker YunoHost Elestio
Cloudron PikaPods Zeabur
ClawCloud Hostinger

For more cloud hosting options, see the list of cloud providers or Chatons (a directory of ethical hosting providers).

Manual install

  1. Get FreshRSS with git or by downloading the archive
  2. Put the application somewhere on your server (expose only the ./p/ folder to the Web)
  3. Add write access to the ./data/ folder for the webserver user
  4. Access FreshRSS with your browser and follow the installation process
  5. Everything should be working :) If you encounter any problems, feel free to contact us.
  6. Advanced configuration settings can be found in config.default.php and modified in data/config.php.
  7. When using Apache, enable AllowEncodedSlashes for better compatibility with mobile clients.

More detailed information about installation and server configuration can be found in our documentation.

Advice

FAQ

Extensions

FreshRSS supports further customizations by adding extensions on top of its core functionality. See the repository dedicated to those extensions.

Internationalization: 20+ languages. Translation progress

Language Progress
Azərbaycanca (az) ■■■■■■■■■■ 100% contribute
Čeština (cs) ■■■■■■■■・・ 81% contribute
Deutsch (de) ■■■■■■■■■・ 99% contribute
Ελληνικά (el) ■■■■■■■・・・ 75% contribute
English (en) ■■■■■■■■■■ 100% contribute
English (United States) (en-US) ■■■■■■■■■■ 100% contribute
Español (es) ■■■■■■■■■■ 100% contribute
فارسی (fa) ■■■■■■■■■・ 98% contribute
Suomi (fi) ■■■■■■■■■・ 91% contribute
Français (fr) ■■■■■■■■■・ 99% contribute
עברית (he) ■■■■・・・・・・ 41% contribute
Magyar (hu) ■■■■■■■■■・ 98% contribute
Bahasa Indonesia (id) ■■■■■■■■■・ 99% contribute
Italiano (it) ■■■■■■■■■・ 98% contribute
日本語 (ja) ■■■■■■■■■・ 99% contribute
한국어 (ko) ■■■■■■■■・・ 80% contribute
Lietuvių (lt) ■■■■■■■■■・ 99% contribute
Latviešu (lv) ■■■■■■■■・・ 81% contribute
Nederlands (nl) ■■■■■■■■■・ 98% contribute
Occitan (oc) ■■■■■■■・・・ 73% contribute
Polski (pl) ■■■■■■■■■・ 98% contribute
Português (Brasil) (pt-BR) ■■■■■■■■■■ 100% contribute
Português (Portugal) (pt-PT) ■■■■■■■■・・ 80% contribute
Русский (ru) ■■■■■■■■■・ 98% contribute
Slovenčina (sk) ■■■■■■■■・・ 81% contribute
Türkçe (tr) ■■■■■■■■■・ 99% contribute
Українська (uk) ■■■■■■■■■・ 98% contribute
简体中文 (zh-CN) ■■■■■■■■■・ 96% contribute
正體中文 (zh-TW) ■■■■■■■■■・ 97% contribute

APIs & native apps

FreshRSS supports access from mobile / native apps for Linux, Android, iOS, Windows and macOS, via two distinct APIs: Google Reader API (best), and Fever API (limited features, less efficient, less safe).

App Platform Free Software Maintained & Developed API Works offline Fast sync Fetch more in individual views Fetch read articles Favourites Labels Podcasts Manage feeds
Capy Reader Android ✓ ✓✓ GReader ✓ ⭐⭐⭐ ✓ ✓ ✓ ✓ ✓ ✓
Readrops Android ✓ ✓✓ GReader ✓ ⭐⭐⭐ – ✓ ✓ – – ✓
FeedMe Android – ✓✓ GReader ✓ ⭐⭐ – – ✓ ✓ ✓ ✓
FocusReader Android – ✓✓ GReader ✓ ⭐⭐ – – ✓ ✓ ✓ ✓
Read You Android ✓ ✓✓ GReader ✓ ⭐⭐ ✓ ✓ ✓ – – ✓
Your News Android, iOS – ✓✓ GReader – ⭐ ✓ ✓ ✓ – – –
Fluent Reader Lite Android, iOS ✓ ✓ GReader ✓ ⭐⭐ – – ✓ – – –
FeedFlow Android, iOS, Linux, macOS, Windows ✓ ✓✓ GReader ✓ ? ? ? ✓ ? – ✓
FriRSS Web (self-hosted) ✓ ✓✓ GReader – ? ✓ ✓ ✓ ✓ – ✓
App Platform Free Software Maintained & Developed API Works offline Fast sync Fetch more in individual views Fetch read articles Favourites Labels Podcasts Manage feeds
Fluent Reader Windows, Linux, macOS ✓ ✓✓ GReader ✓ ⭐ – ✓ ✓ – – –
RSS Guard Windows, GNU/Linux, macOS, OS/2 ✓ ✓✓ GReader ✓ ⭐⭐ – ✓ ✓ ✓ ✓ ✓
NewsFlash GNU/Linux ✓ ✓✓ GReader – ⭐⭐ – ✓ ✓ ✓ – –
Newsboat GNU/Linux, macOS, FreeBSD ✓ ✓✓ GReader – ⭐ – ✓ ✓ – ✓ –
FluentFlame Reader Windows, Linux, macOS ✓ Work in progress GReader ✓ ? ? ? ✓ – – –
App Platform Free Software Maintained & Developed API Works offline Fast sync Fetch more in individual views Fetch read articles Favourites Labels Podcasts Manage feeds
Vienna RSS macOS ✓ ✓✓ GReader ? ? ? ? ? ? ? ?
Readkit iOS, macOS – ✓✓ GReader ✓ ⭐⭐⭐ – ✓ ✓ – ✓ $
Reeder Classic iOS, macOS – ✓✓ GReader ✓ ⭐⭐⭐ – ✓ ✓ – – ✓
lire iOS, macOS – ✓✓ GReader ? ? ? ? ? ? ? ?
Unread iOS – ✓✓ Fever ✓ ? ? ? ✓ – – –
Fiery Feeds iOS – ✓✓ Fever ? ? ? ? ? – – –
Netnewswire iOS, macOS ✓ Work in progress GReader ✓ ? ? ? ✓ – – ✓

Included libraries

Additional credits

Alternatives

If FreshRSS does not suit you for one reason or another, here are alternative solutions to consider:

FreshRSS (FreshRSS/FreshRSS)

Searching Database…

16.3K ·GitHub
这是干什么的?FreshRSS 是一个免费的自托管 RSS 阅读器(订阅聚合工具):它把你所有的新闻订阅源汇集到一个网页界面里。它轻量且可自定义,支持多用户(还带有匿名阅读模式),同时提供客户端 API 和命令行工具。
这是我在网上注册就能用的服务,还是得自己部署运行?需要自己部署运行:它是一个 PHP 网页应用,安装在你自己的服务器上。如果觉得维护服务器太麻烦,README 里列出了一些可以替你托管的云服务商(包括注重理念的 Chatons 目录)。
怎么在我自己的服务器上把它跑起来?用 git 或压缩包下载,把它放到你的服务器上,只把 ./p/ 文件夹暴露给网络,给网页服务器对 ./data/ 的写权限,然后在浏览器里或通过命令行界面完成安装设置。
除了 FreshRSS 的代码本身,我的服务器还需要什么?需要一个支持 PHP 的网页服务器,因为它本身是 PHP 应用。README 里明确说明了 Apache 的配置:在 Apache 上启用 AllowEncodedSlashes,以便更好地兼容移动客户端。
安装好之后有什么需要小心的地方吗?只把 ./p/ 文件夹暴露给网络:./data/ 存放着所有个人数据,必须保持私密。如果出问题了,可以通过界面查看日志,日志文件在 ./data/users/ /log.txt。
我能用手机看我的订阅源吗,还是只能在网页界面看?有 Android、iOS、Windows、macOS 和 Linux 的原生应用,它们通过两种 API 连接:Google Reader API(最佳选择)和 Fever API(功能有限、效率较低、安全性较差)。README 里列出了 Capy Reader、Newsboat 和 Reeder Classic 等应用。
为什么刚导入的订阅源里的文章全都显示在最上面?这是正常现象:显示的日期是订阅源本身声明的日期,而不是 FreshRSS 收到文章的时间,而且排序并不依据日期——所以刚导入的内容不管文章日期如何,都会堆在最上面。
我能把我挑选的文章分享给别人吗?可以——FreshRSS 能把选中的文章以 HTML、RSS 或 OPML 的形式再分享出去,别人可以用任何阅读器关注你的推荐。
除了自带的功能,它还能扩展吗?可以,FreshRSS 支持扩展,能在核心功能之上增加新功能,还有一个专门的仓库来收集这些扩展。
它有我用的语言版本吗?它已被翻译成 20 多种语言,从英语、法语、德语、西班牙语到日语、中文、俄语都有,并且每种语言的翻译进度都有专门的追踪。
Creator
FreshRSS
Size
35.8 MB
Stars
16.3K
Age
13y
Commits · 90 Days