diff options
Diffstat (limited to 'docs/admin.md')
| -rw-r--r-- | docs/admin.md | 20 |
1 files changed, 13 insertions, 7 deletions
diff --git a/docs/admin.md b/docs/admin.md index 00efe0d20..9579b91ba 100644 --- a/docs/admin.md +++ b/docs/admin.md @@ -1,17 +1,22 @@ # Admin Welcome to the Admin documentation this page explains some of the configuration options for news. ## System Cron -Nextcloud uses Cron to run regular jobs, News relies on the Job system to execute the feed updates. +Nextcloud uses cron to run regular jobs, News relies on the Job system to execute the feed updates. Alternatively you may use an [external updater](https://nextcloud.github.io/news/clients/#update-clients), in this case you need to disable the system cron in the settings. ## Auto purge count -This value represents the maximum amount of read items per feed, which won't be deleted by the cleanup job. -For example if the value is 200 there can be maximum 200 read items per feed, unread items are unaffected. +This value represents the maximum amount of read items (articles) per feed, which won't be deleted by the cleanup job. +For example, if the value is 200 there can be maximum 200 read items per feed, unread items are unaffected. If old articles reappear after being read, try to increase this value. -To disable this feature use -1. +To disable this feature, use -1. + +## Purge unread items +This changes the behavior of the auto purging to also purge unread items. This is useful if you have users with a lot of unread items. +If you set the Auto purge count to 200 the latest 200 read and unread items will be kept per feed. +Starred items are always kept. ## Explore Service -If you are using the News app in your company/community it might be interesting to offer your users a bunch of easily to discover default feeds. You could also create a website where people can add and up-vote news feeds like bigger cloud feed readers like Feedly do it or even convert their APIs into a service for the News app (if someone wants to provide one for the News app, feel free to contact us by creating an issue in the bug tracker). +If you are using the News app in your company/community, it might be interesting to offer your users a bunch of easily to discover default feeds. You could also create a website where people can add and up-vote news feeds like bigger cloud feed readers like Feedly do it or even convert their APIs into a service for the News app (if someone wants to provide one for the News app, feel free to contact us by creating an issue in the bug tracker). The URL should be a path to a directory which contains a JSON file in the format of **feeds.LANG_CODE.json** where LANG_CODE is a two character language code (e.g. **en** or **de**). @@ -23,11 +28,12 @@ For example, entering the URL **https://domain.com/directory** as explore URL wi ## Update Interval The update interval is used to determine when the next update of all feeds should be done. -You can configure this interval as an administrator. +By default, the value is set to 3600 seconds (1 hour) You can configure this interval as an administrator. +The new value is only applied after the next run of the updater. ### What is a good update interval? That depends on your individual needs. Please keep in mind that the lower you set your update interval, the more traffic is generated. ### Can I set individual update intervals per feed/user? -No, the job framework of Nextcloud is pretty simple.
\ No newline at end of file +No, that is not possible.
\ No newline at end of file |