mirror of
https://github.com/FreshRSS/FreshRSS.git
synced 2026-05-14 10:13:52 -04:00
e416117591
Closes FreshRSS/FreshRSS#6522. Refresh of FreshRSS/FreshRSS#6590 by @sgzmd, which has been stalled with merge conflicts since 2024. All original commits are preserved as-is in the history (authorship intact); this PR adds a merge with current `edge` plus minor fixes. ## Summary Adds a user setting `show_title_unread` (default `true`, so existing behavior is preserved) that hides the unread article counter from both the tab title and the favicon overlay. A single toggle controls both, matching the request in #6522. ## Screenshots Toggle in display settings: <img width="320" height="127" alt="Display settings with new toggle" src="https://github.com/user-attachments/assets/fc78f825-161d-4b47-9b85-08e39554a4b1" /> Tab title and favicon when **enabled** (current behavior): <img width="253" height="42" alt="Tab title and favicon with unread counter" src="https://github.com/user-attachments/assets/57387600-72e0-4b22-b059-04b5bfea673a" /> Tab title and favicon when **disabled** (new behavior): <img width="254" height="40" alt="Tab title and favicon without unread counter" src="https://github.com/user-attachments/assets/93ac7997-dd4e-49bc-ab4a-74e4f0d2db1b" /> ## Changes on top of #6590 - Resolved merge conflicts with current `edge` (controllers, model, view, `config.default.php`, ~25 i18n files, plus the `zh-tw` -> `zh-TW` rename). - Replaced Czech text mistakenly placed in `de/conf.php` with an English `// TODO` marker so a German speaker can translate later. - Renamed JS context key `show_unread_favicon` -> `show_title_unread` to match the backend property and avoid a confusing dual-name for one setting. - Removed an unused duplicate of `show_title_unread` from `config.default.php` (the setting is read via `userConf()`, never `systemConf()`). - Gated the dynamic title rewrite in `incUnreadsFeed` (`p/scripts/main.js`) on the setting. Without this, marking an article read while the setting was off would re-add the `(N)` prefix to the tab title. - Escaped a stray apostrophe in the Occitan translation that broke parsing. - `make fix-all` re-sorted i18n keys and added `// TODO` placeholders for `fi`, `pt-PT`, `uk` (untranslated by the original PR). ## Test plan - [x] `make test-all` passes (620/620 PHPUnit, phpstan, phpcs, eslint, stylelint, markdownlint clean; `bin/typos` failed locally with a binary arch mismatch on macOS arm64 - unrelated to this change). - [x] Manually tested on a real instance: default behavior unchanged; toggling the setting hides both the tab title `(N) ` prefix and the favicon overlay; toggling back restores both; marking articles read while the setting is off does not bring the counter back; opening and closing an article preserves the user's choice. * Make showing the number of unread items in the title configurable. * Proposed approach to passing show_unread_favicon setting down to client-side code * Fixes and refactoring * Updating default config for the user. When user's config wasn't initialised we are copying it from `config-user.default.php` - if `show_title_unread` is not there, it is assumed to be false, whereas in `config.default.php` it's true by default. This results in inconsistency until user changes the field for the first time in Config->Display. * Adding translations. * fix: gate JS title rewrite + drop dead system config entry The original PR added show_title_unread to both config-user.default.php (read by userConf, the right place) and config.default.php (read by systemConf, never used here). Drop the system-level entry. Also: incUnreadsFeed dynamically rewrites document.title when articles are marked read/unread. That code path was not gated by the setting, so toggling the setting off and then marking an article read would re-add the (N) prefix to the tab title. Skip the document.title / prevTitle write when context.show_title_unread is false. * fix: drop README pollution from local make fix-all `make fix-all` regenerated the README translation tables on macOS, where the case-insensitive filesystem and an untracked local `app/i18n/nb/` directory caused the generator to emit `zh-tw` (lowercase) and an `nb` entry. Reset both README files to upstream/edge so CI can regenerate them cleanly. * fix: restore zh-TW/conf.php from edge (case-insensitive FS damage) The macOS case-insensitive filesystem caused the merge to overwrite upstream/edge's properly-translated zh-TW/conf.php with the older zh-tw/conf.php content from the PR side, regressing translation coverage from 94% to 71%. Reset the file to edge's content and re-add the show_title_unread Traditional Chinese translation. --------- Co-authored-by: sgzmd <sigizmund@gmail.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> Co-authored-by: Bjørn A. Andersen <polybjorn@users.noreply.github.com>
- Read this document on github.com/FreshRSS/FreshRSS/ to get the correct links and pictures.
- Version française
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.
- Official website: https://freshrss.org
- Demo: https://demo.freshrss.org
- 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 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.mdfor coding conventions (both for humans and AI agents).
- Check
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
 |
 |
 |
 |
 |
 |
 |
 |
Manual install
- Get FreshRSS with git or by downloading the archive
- Put the application somewhere on your server (expose only the
./p/folder to the Web) - Add write access to the
./data/folder for the webserver user - Access FreshRSS with your browser and follow the installation process
- or use the Command-Line Interface
- Everything should be working :) If you encounter any problems, feel free to contact us.
- Advanced configuration settings can be found in config.default.php and modified in
data/config.php. - When using Apache, enable
AllowEncodedSlashesfor 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.
- Be aware that the
- The
./constants.phpfile 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*.txtfiles.- The special folder
./data/users/_/contains the part of the logs that are shared by all users.
- The special folder
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
| Language | Progress | |
|---|---|---|
| Čeština (cs) | ￭￭￭￭￭￭￭￭･･ 82% | contribute |
| Deutsch (de) | ￭￭￭￭￭￭￭￭￭･ 99% | contribute |
| Ελληνικά (el) | ￭￭￭･･･････ 38% | contribute |
| English (en) | ￭￭￭￭￭￭￭￭￭￭ 100% | contribute |
| English (United States) (en-US) | ￭￭￭￭￭￭￭￭￭￭ 100% | contribute |
| Español (es) | ￭￭￭￭￭￭￭￭￭･ 99% | contribute |
| فارسی (fa) | ￭￭￭￭￭￭￭￭￭･ 91% | contribute |
| Suomi (fi) | ￭￭￭￭￭￭￭￭￭･ 93% | contribute |
| Français (fr) | ￭￭￭￭￭￭￭￭￭￭ 100% | contribute |
| עברית (he) | ￭￭￭￭･･････ 42% | contribute |
| Magyar (hu) | ￭￭￭￭￭￭￭￭￭･ 97% | contribute |
| Bahasa Indonesia (id) | ￭￭￭￭￭￭￭￭￭･ 90% | contribute |
| Italiano (it) | ￭￭￭￭￭￭￭￭￭･ 99% | contribute |
| 日本語 (ja) | ￭￭￭￭￭￭￭￭･･ 88% | contribute |
| 한국어 (ko) | ￭￭￭￭￭￭￭￭･･ 82% | contribute |
| Latviešu (lv) | ￭￭￭￭￭￭￭￭･･ 83% | contribute |
| Nederlands (nl) | ￭￭￭￭￭￭￭￭￭･ 97% | contribute |
| Occitan (oc) | ￭￭￭￭￭￭￭･･･ 75% | contribute |
| Polski (pl) | ￭￭￭￭￭￭￭￭￭･ 99% | contribute |
| Português (Brasil) (pt-BR) | ￭￭￭￭￭￭￭￭￭･ 98% | contribute |
| Português (Portugal) (pt-PT) | ￭￭￭￭￭￭￭￭･･ 82% | contribute |
| Русский (ru) | ￭￭￭￭￭￭￭￭￭･ 97% | contribute |
| Slovenčina (sk) | ￭￭￭￭￭￭￭￭･･ 82% | contribute |
| Türkçe (tr) | ￭￭￭￭￭￭￭￭￭･ 90% | contribute |
| Українська (uk) | ￭￭￭￭￭￭￭￭￭･ 92% | contribute |
| 简体中文 (zh-CN) | ￭￭￭￭￭￭￭￭￭･ 98% | contribute |
| 正體中文 (zh-TW) | ￭￭￭￭￭￭￭￭￭･ 94% | 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 | ✔️ | ⭐⭐ | ➖ | ➖ | ✓ | ➖ | ➖ | ➖ |
| 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 | ➖ | ⭐ | ➖ | ✔️ | ✔️ | ➖ | ✔️ | ➖ |
| 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
- Based on a modified version of the MINZ framework.
- Some icons come from the GNOME project
- Fonts: Open Sans, Lato, Spectral
Alternatives
If FreshRSS does not suit you for one reason or another, here are alternative solutions to consider:
- Kriss Feed
- Leed
- And more… (but if you like FreshRSS, give us a vote!)