summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBenjamin Brahmer <info@b-brahmer.de>2022-10-12 09:19:32 +0200
committerBenjamin Brahmer <info@b-brahmer.de>2022-10-12 09:19:32 +0200
commit9ecda4d20afe31cfcc14b747f4aad9588c279893 (patch)
treea37ffb66ae290ea5b3e723abfbb3ab48f65af269
parent6f9d3bdbcd748f1b7a73d51b2acc23b88c001301 (diff)
Update documentationdocs/cleanup
Signed-off-by: Benjamin Brahmer <info@b-brahmer.de>
-rw-r--r--docs/admin.md20
-rw-r--r--docs/faq.md13
2 files changed, 20 insertions, 13 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
diff --git a/docs/faq.md b/docs/faq.md
index bfb62e3e9..e9c4d5e95 100644
--- a/docs/faq.md
+++ b/docs/faq.md
@@ -28,7 +28,7 @@ Since an attacker can not execute code in contrast to mixed active content, but
### Why don't you simply use an HTTPS image/audio/video proxy
-For the same reason that we can't fix non HTTPS websites: It does not fix the underlying issue but only silences it. If you are using an image HTTPS proxy, an attacker can simply attack your image proxy since the proxy fetches insecure content. **Even worse**: if your image proxy serves these images from the same domain as your Nextcloud installation you [are vulnerable to XSS via SVG images](https://www.owasp.org/images/0/03/Mario_Heiderich_OWASP_Sweden_The_image_that_called_me.pdf). In addition, people feel safe when essentially they are not.
+For the same reason that we can't fix non HTTPS websites: It does not fix the underlying issue, but only silences it. If you are using an image HTTPS proxy, an attacker can simply attack your image proxy since the proxy fetches insecure content. **Even worse**: if your image proxy serves these images from the same domain as your Nextcloud installation, you [are vulnerable to XSS via SVG images](https://www.owasp.org/images/0/03/Mario_Heiderich_OWASP_Sweden_The_image_that_called_me.pdf). In addition, people feel safe when essentially they are not.
Since most people don't understand mixed content and don't have two domains and a standalone server for the image proxy, it is very likely they will choose to host it under the same domain.
@@ -91,13 +91,14 @@ By appending **?subscribe_to=SOME_URL** to your News app URL, you can launch the
## Database table grows too big
+If your users have subscribed to some high-volume feeds where a lot of items remain unread,
+this can lead to an oversized news table over time. As a consequence, the database upgrade of the news app can take several hours, during which Nextcloud cannot be used.
+
By default, Nextcloud News purges old news items above a certain threshold each time it fetches new news items. The maximum number of items per feed
that should be kept during the purging can be defined through the “Maximum read count per feed” setting in the admin UI or the `autoPurgeCount`
-value in the config. (Note: The “Purge interval” (`autoPurgeMinimumInterval`) setting is ignored and does not have any effect.)
-
-However, unread or starred items are exempt from the purging. If your users have subscribed to some high-volume feeds where a lot of items remain
-unread, this can lead to an oversized news table over time. As a consequence, the database upgrade of the news app can take several hours, during which
-Nextcloud cannot be used.
+value in the config.
+Additionally you may enable the option to also purge unread items `purgeUnread`. This is useful if your users have large amounts of unread items.
+Starred items are always exempt from purging.
The command `occ news:updater:after-update [--purge-unread] [<purge-count>]` can be used to manually purge old news items across the instance. With
the `--purge-unread` option, unread items are also purged (starred items are still exempt). If `purge-count` is not specified, the configured