From b0778944f2628a28b5f9781a4d49337e519d999b Mon Sep 17 00:00:00 2001 From: Benjamin Brahmer Date: Sun, 10 May 2026 16:03:42 +0000 Subject: [PATCH 1/6] update user documentation, remove clients that are no longer maintained Signed-off-by: Benjamin Brahmer --- docs/clients.md | 21 ++++++++++---------- docs/user.md | 51 +++++++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 58 insertions(+), 14 deletions(-) diff --git a/docs/clients.md b/docs/clients.md index ae046960a4..fa30c4da90 100644 --- a/docs/clients.md +++ b/docs/clients.md @@ -3,10 +3,20 @@ Clients are applications that use the REST API of News. They are not maintained by the News team. If you are the developer of an app, feel free to create a PR to add your app to this list. +## Recommended Clients + +Based on activity and maintenance status we can recommend these clients: + +- Android: [Nextcloud News Reader](https://play.google.com/store/apps/details?id=de.luhmer.owncloudnewsreader) (official Nextcloud News client) +- Desktop (Windows/Linux/macOS): [RSS Guard](https://github.com/martinrotter/rssguard) +- Terminal: [newsboat](https://newsboat.org/) + ## Sync Clients A sync client can be used to read news and synchronize via the API. +Last reviewed: May 2026 + | Name | OS/Platform | License | Source | |------------------------------------------------------------------------------------------------------------------|------------------------------|----------------------|--------------------------------------------------------------------| | [RSS Guard](https://github.com/martinrotter/rssguard) | Windows, Linux, OS/2, macOS | GPL-3.0 License | [GitHub](https://github.com/martinrotter/rssguard) | @@ -14,23 +24,14 @@ A sync client can be used to read news and synchronize via the API. | [Communique](https://flathub.org/apps/details/com.github.suzie97.communique) | Linux | LGPL-2.1 License | [GitHub](https://github.com/Suzie97/Communique) | | [NewsFlash](https://flathub.org/apps/details/com.gitlab.newsflash) | Linux | GPL-3.0 License | [GitLab](https://gitlab.com/news-flash/news_flash_gtk) | | [Nextcloud News Reader](https://play.google.com/store/apps/details?id=de.luhmer.owncloudnewsreader) | Android | GPL-3.0 License | [GitHub](https://github.com/nextcloud/news-android-app) | -| [OCReader](https://f-droid.org/repository/browse/?fdid=email.schaal.ocreader) | Android | GPL-3.0 License | [GitHub](https://github.com/schaal/ocreader) | -| [Newsout](https://play.google.com/store/apps/details?id=com.inspiredandroid.newsout) | Android | Apache-2.0 License | [GitHub](https://github.com/SimonSchubert/NewsOut) | | [Readrops](https://f-droid.org/en/packages/com.readrops.app/) | Android | GPL-3.0 License | [GitHub](https://github.com/readrops/Readrops) | -| [CloudNews](https://apps.apple.com/app/cloudnews-owncloud-news-reader/id683859706) | iOS | BSD-2-Clause License | [GitHub](https://github.com/owncloud/news-ios-app) | | [Fiery Feeds](http://cocoacake.net/) | iOS, macOS | - | - | -| [Nextnews](https://apps.apple.com/us/app/nextnews/id1573041539) | iOS | - | - | -| [News Checker](https://chrome.google.com/webstore/detail/owncloud-news-checker/hnmagnmdnfdhabdlicankfbfhcdgbfhe) | Google Chrome | - | [GitHub](https://github.com/owncloud-archive/news-chrome-notifier) | -| [own News](https://appworld.blackberry.com/webstore/content/32767887/) | Blackberry | - | - | -| [FeedSpider](https://www.feedspider.net/) | Firefox OS, webOS, LuneOS | MIT License | [GitHub](https://github.com/OthelloVentures/feedspider) | -| [fastReader](https://www.windowsphone.com/en-us/store/app/fastreader/e55e696d-aa45-4a49-bb1c-a1fc7fdabec1) | Windows Phone | - | - | | [py3status](https://github.com/ultrabug/py3status/) | i3wm | BSD-3-Clause License | [GitHub](https://github.com/ultrabug/py3status/) | | [newsboat](https://newsboat.org/) | Unix Terminal | MIT License | [GitHub](https://github.com/newsboat/newsboat) | -| [Newsie](https://open-store.io/app/newsie.martinferretti) | Ubuntu Touch | GPL-3.0 License | [GitLab](https://gitlab.com/ferrettim/newsie) | -| [Fuoten](https://github.com/Huessenbergnetz/Fuoten) | Sailfish OS | GPL-3.0 License | [GitHub](https://github.com/Huessenbergnetz/Fuoten) | ## Update Clients An update client uses the News API or the OCC CLI to update the feeds in News. * [Python multithread updater](https://github.com/nextcloud/news-updater) + diff --git a/docs/user.md b/docs/user.md index 1104d2f97c..0e5bc0ed09 100644 --- a/docs/user.md +++ b/docs/user.md @@ -22,7 +22,7 @@ Provide a username and password if required for a feed. Please note that the pas ### Auto discover Feed Check this option if you want the app to automatically detect the RSS feed from the entered URL. This is useful when you’re unsure of the exact feed URL, as the system will scan the provided website for RSS links. -## Feed options +## Feed settings ### Mark Read Mark the feed as read. @@ -53,6 +53,41 @@ Delete the feed. ### Open Feed URL Open the feed in a new tab or window. +### Keyword Filters +You can hide unwanted articles per feed by defining keyword filters. + +How to open filters for a feed: +- Open **Feed Settings**. +- In the feed table, find your feed and click the **Keyword filters** icon in the options column. + +How to add or change filters: +- Enter comma-separated keywords in one or more fields: + - **Title keywords** + - **Body keywords** + - **URL keywords** +- Click **Save**. + +How matching works: +- Matching is **case-insensitive**. +- **Title** and **Body** keywords match **whole words**. +- **URL** keywords match **URL fragments**. +- If an article matches any configured keyword, it is hidden for that feed. + +How to see that items were filtered: +- Filtered items are hidden from the article list. +- If you expect an article but do not see it, open the feed's **Keyword filters** and review the configured keywords. +- To verify quickly, temporarily remove a keyword (or click **Clear**) and check if the article appears. + +How to remove filters: +- Open the same dialog and click **Clear** to remove all keywords for that feed. + +Simple example: +- You want to hide promotional posts in one feed. +- Set **Title keywords** to `sponsored, advertisement`. +- Set **Body keywords** to `partner content`. +- Click **Save**. +- Articles from that feed that contain these keywords will no longer be shown as unread. + ## Settings ### Keyboard Shortcuts @@ -115,7 +150,15 @@ Feed lists in OPML format can be imported and exported here. Feeds that cannot b # Using News with Clients -## TODO -This documentation is work in progress. -explain sync and link to clients page +To use News with a mobile or desktop client: +- Add your Nextcloud server URL and your account/app password in the client. +- Follow the setup steps from the client itself (server address, credentials, and sync options). +- After setup, the client syncs with your News server. + +What gets synced: +- Read/unread status +- Starred items +- Feed and folder structure + +See the available clients and setup links on the [Clients](clients.md) page. From e781f477083017ee2ce1a6634e5de4c1fb88b4d3 Mon Sep 17 00:00:00 2001 From: Benjamin Brahmer Date: Sun, 10 May 2026 18:12:49 +0200 Subject: [PATCH 2/6] Fix spelling Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Benjamin Brahmer --- docs/user.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user.md b/docs/user.md index 0e5bc0ed09..6be5047890 100644 --- a/docs/user.md +++ b/docs/user.md @@ -57,7 +57,7 @@ Open the feed in a new tab or window. You can hide unwanted articles per feed by defining keyword filters. How to open filters for a feed: -- Open **Feed Settings**. +- Open **Feed settings**. - In the feed table, find your feed and click the **Keyword filters** icon in the options column. How to add or change filters: From da468bada1ac8d2dc2aa097be42a235c0265e815 Mon Sep 17 00:00:00 2001 From: Benjamin Brahmer Date: Sun, 10 May 2026 18:13:08 +0200 Subject: [PATCH 3/6] Fix for spelling Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Benjamin Brahmer --- docs/clients.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/clients.md b/docs/clients.md index fa30c4da90..cb8b5f4765 100644 --- a/docs/clients.md +++ b/docs/clients.md @@ -5,7 +5,7 @@ If you are the developer of an app, feel free to create a PR to add your app to ## Recommended Clients -Based on activity and maintenance status we can recommend these clients: +Based on activity and maintenance status, we can recommend these clients: - Android: [Nextcloud News Reader](https://play.google.com/store/apps/details?id=de.luhmer.owncloudnewsreader) (official Nextcloud News client) - Desktop (Windows/Linux/macOS): [RSS Guard](https://github.com/martinrotter/rssguard) From 8a16d2f70220d20c88b911fe3c67af01beb1e19b Mon Sep 17 00:00:00 2001 From: Benjamin Brahmer Date: Sun, 10 May 2026 16:18:23 +0000 Subject: [PATCH 4/6] fixup Signed-off-by: Benjamin Brahmer --- docs/user.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/docs/user.md b/docs/user.md index 6be5047890..0fe5be926a 100644 --- a/docs/user.md +++ b/docs/user.md @@ -71,12 +71,16 @@ How matching works: - Matching is **case-insensitive**. - **Title** and **Body** keywords match **whole words**. - **URL** keywords match **URL fragments**. -- If an article matches any configured keyword, it is hidden for that feed. +- If an article matches any configured keyword, it is marked as read and treated as filtered. +- In unread-focused views this effectively hides the item from the unread list. +- If **Show all articles** is enabled, filtered items are still visible but marked as filtered. How to see that items were filtered: -- Filtered items are hidden from the article list. +- In the web frontend, filtered items show a **filtered icon**. +- Filtered items usually disappear from unread-focused views because they are marked as read. - If you expect an article but do not see it, open the feed's **Keyword filters** and review the configured keywords. -- To verify quickly, temporarily remove a keyword (or click **Clear**) and check if the article appears. +- Clearing or changing filters does **not** automatically restore unread status for items that were already marked as read by filtering. +- To verify a filter, check newly fetched articles (or manually mark older items as unread first). How to remove filters: - Open the same dialog and click **Clear** to remove all keywords for that feed. From 2b02caa2f039d0aee0e7652562b96acd467e0aa5 Mon Sep 17 00:00:00 2001 From: Benjamin Brahmer Date: Sun, 10 May 2026 18:23:49 +0200 Subject: [PATCH 5/6] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Benjamin Brahmer --- docs/user.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user.md b/docs/user.md index 0fe5be926a..9183f029aa 100644 --- a/docs/user.md +++ b/docs/user.md @@ -72,7 +72,7 @@ How matching works: - **Title** and **Body** keywords match **whole words**. - **URL** keywords match **URL fragments**. - If an article matches any configured keyword, it is marked as read and treated as filtered. -- In unread-focused views this effectively hides the item from the unread list. +- Because matching articles are marked as read, they drop out of unread-focused views; whether they remain visible depends on the current view and settings. - If **Show all articles** is enabled, filtered items are still visible but marked as filtered. How to see that items were filtered: From c3619f4b861a36428dbd1d20d4367f8eddd35bdf Mon Sep 17 00:00:00 2001 From: Benjamin Brahmer Date: Sun, 10 May 2026 18:23:57 +0200 Subject: [PATCH 6/6] Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Benjamin Brahmer --- docs/user.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user.md b/docs/user.md index 9183f029aa..99b3a1dc5f 100644 --- a/docs/user.md +++ b/docs/user.md @@ -77,7 +77,7 @@ How matching works: How to see that items were filtered: - In the web frontend, filtered items show a **filtered icon**. -- Filtered items usually disappear from unread-focused views because they are marked as read. +- Filtered items are hidden from unread-focused views because they are marked as read, but they remain visible in views that show all articles. - If you expect an article but do not see it, open the feed's **Keyword filters** and review the configured keywords. - Clearing or changing filters does **not** automatically restore unread status for items that were already marked as read by filtering. - To verify a filter, check newly fetched articles (or manually mark older items as unread first).