• Read this document on github.com/FreshRSS/FreshRSS/ to get the correct links and pictures.
• [Version française](README.fr.md)

FreshRSS

FreshRSS is a self-hosted RSS feed aggregator.

It is lightweight, easy to work with, powerful, customizable, and has been [translated](#internationalization-20-languages-translation-progress) 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](cli/README.md).

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](#extensions) for further tuning.

• Official website:
• Demo:
• License: GNU AGPL 3


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](.devcontainer/README.md) is available:


Screenshot


Disclaimer

FreshRSS comes with absolutely no warranty.

Documentation

• User documentation, where you can discover all the possibilities offered by FreshRSS
• Administrator documentation for detailed installation and maintenance related tasks
• Developer documentation to guide you in the source code of FreshRSS and to help you if you want to contribute
• Contributor guidelines for those who want to help improve FreshRSS

* Check [AGENTS.md](AGENTS.md) for coding conventions (both for humans and AI agents).

Requirements

• A recent browser like Firefox / IceCat, Edge, Chromium / Chrome, Opera, Safari.

* Works on mobile (except a few features)

• Light server running Linux or Windows

* It even works on Raspberry Pi 1 with response time under a second (tested with 150 feeds, 22k articles)

• A Web server: Apache2.4+ (recommended), nginx, lighttpd (not tested on others)
• PHP 8.1+

* Required extensions: cURL, DOM, JSON, XML, session, ctype * Recommended extensions: PDO_SQLite (for export/import), GMP (for API access on 32-bit platforms), IDN (for Internationalized Domain Names), mbstring (for Unicode strings), iconv (for charset conversion), ZIP (for import/export), zlib (for compressed feeds) * Extension for database: PDO_PGSQL or PDO_SQLite or PDO_MySQL

• PostgreSQL 10+ or SQLite or MariaDB 10.6+ or MySQL 8.0+

Installation

The latest stable release can be found on GitHub. New versions are released every two to three months.

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

Automated install

| | | |
|-|-|-|
| [](./Docker/) | [](https://install-app.yunohost.org/?app=freshrss) | [](https://elest.io/open-source/freshrss) |
| [](https://cloudron.io/button.html?app=org.freshrss.cloudronapp) | [](https://www.pikapods.com/pods?run=freshrss) | [](https://zeabur.com/templates/MD4TRW) |
| [](https://template.run.claw.cloud/?openapp=system-fastdeploy%3FtemplateName%3Dfreshrss) | [](https://www.hostinger.com/vps/docker-hosting?compose_url=https://github.com/FreshRSS/FreshRSS/blob/edge/Docker/freshrss/docker-compose.yml) | |

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
* or use the [Command-Line Interface](cli/README.md)
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](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

• For better security, expose only the ./p/ folder to the Web.

* Be aware that the ./data/ folder contains all personal data, so it is a bad idea to expose it.

• The ./constants.php file defines access to the application folder. If you want to customize your installation, look here first.
• If you encounter any problem, logs are accessible from the interface or manually in ./data/users/*/log*.txt files.

* The special folder ./data/users/_/ contains the part of the logs that are shared by all users.

FAQ

• The date and time in the right-hand column is the date declared by the feed, not the time at which the article was received by FreshRSS, and it is not used for sorting.

* In particular, when importing a new feed, all of its articles will appear at the top of the feed list regardless of their declared date.

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

<!-- This section is automatically generated by ./cli/check.translation.php -g -->

| Language | Progress | |
| - | - | - |
| Čeština (cs) | ￭￭￭￭￭￭￭￭･･ 81% | contribute |
| Deutsch (de) | ￭￭￭￭￭￭￭￭￭･ 98% | contribute |
| Ελληνικά (el) | ￭￭￭￭￭￭￭･･･ 75% | contribute |
| English (en) | ￭￭￭￭￭￭￭￭￭￭ 100% | contribute |
| English (United States) (en-US) | ￭￭￭￭￭￭￭￭￭￭ 100% | contribute |
| Español (es) | ￭￭￭￭￭￭￭￭￭･ 99% | contribute |
| فارسی (fa) | ￭￭￭￭￭￭￭￭￭･ 99% | contribute |
| Suomi (fi) | ￭￭￭￭￭￭￭￭￭･ 91% | contribute |
| Français (fr) | ￭￭￭￭￭￭￭￭￭￭ 100% | contribute |
| עברית (he) | ￭￭￭￭･･････ 41% | contribute |
| Magyar (hu) | ￭￭￭￭￭￭￭￭￭･ 99% | contribute |
| Bahasa Indonesia (id) | ￭￭￭￭￭￭￭￭･･ 89% | contribute |
| Italiano (it) | ￭￭￭￭￭￭￭￭￭･ 99% | contribute |
| 日本語 (ja) | ￭￭￭￭￭￭￭￭￭･ 99% | contribute |
| 한국어 (ko) | ￭￭￭￭￭￭￭￭･･ 81% | contribute |
| Latviešu (lv) | ￭￭￭￭￭￭￭￭･･ 81% | contribute |
| Nederlands (nl) | ￭￭￭￭￭￭￭￭￭･ 98% | contribute |
| Occitan (oc) | ￭￭￭￭￭￭￭･･･ 74% | contribute |
| Polski (pl) | ￭￭￭￭￭￭￭￭￭･ 99% | contribute |
| Português (Brasil) (pt-BR) | ￭￭￭￭￭￭￭￭￭･ 98% | 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

…

Collapse