diff --git a/docs/clients.md b/docs/clients.md index ae046960a..cb8b5f476 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 1104d2f97..99b3a1dc5 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,45 @@ 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 marked as read and treated as filtered. +- 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: +- In the web frontend, filtered items show a **filtered icon**. +- 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). + +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 +154,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.