aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar maTh <math-home@web.de> 2023-01-17 23:41:49 +0100
committerGravatar GitHub <noreply@github.com> 2023-01-17 23:41:49 +0100
commit216e39c3cc43061686981b96328796765d264d29 (patch)
treeec19d77b83eb28d8052420c6c0d57dfadf83f0a0 /docs
parent33468def4a5fc0e3af92e5759f463d4d4872fd84 (diff)
Docs: Explain the "Do not automatically refresh more often than" (#5017)
* reordering, config, TOC * fix markdownlint * fix
Diffstat (limited to 'docs')
-rw-r--r--docs/en/users/09_refreshing_feeds.md67
1 files changed, 49 insertions, 18 deletions
diff --git a/docs/en/users/09_refreshing_feeds.md b/docs/en/users/09_refreshing_feeds.md
index ec20c7d62..6d9c2af55 100644
--- a/docs/en/users/09_refreshing_feeds.md
+++ b/docs/en/users/09_refreshing_feeds.md
@@ -1,6 +1,39 @@
# Refreshing feeds
-To take full advantage of FreshRSS, it needs to retrieve new items from the feeds you have subscribed to. There are several ways to do this.
+To take full advantage of FreshRSS, it needs to retrieve new items from the feeds you have subscribed to. There are several ways to do this:
+
+- [Manual update](#manual-update)
+ - [Complete update](#complete-update)
+ - [Partial update](#partial-update)
+- [Automatic update with cron](#automatic-update-with-cron)
+- [Online cron](#online-cron)
+ - [For Form Authentication](#for-form-authentication)
+ - [For HTTP authentication](#for-http-authentication)
+ - [For No authentication None](#for-no-authentication-none)
+- [Feed configuration of “Do not automatically refresh more often than”](#feed-configuration-of-do-not-automatically-refresh-more-often-than)
+ - [Background](#background)
+ - [Default value](#default-value)
+ - [Individual feed configuration](#individual-feed-configuration)
+
+## Manual update
+
+If you can’t or don’t want to use the automatic method, you can update manually. There are two methods for updating all or some of the feeds.
+
+### Complete update
+
+This update occurs on all feeds. To trigger it, simply click on the update link in the navigation menu.
+
+![Navigation menu](../img/users/refresh.1.png)
+
+When the update starts, a progress bar appears and changes while feeds are processed.
+
+![Progress bar](../img/users/refresh.5.png)
+
+### Partial update
+
+This update occurs on the selected feed only. To trigger it, simply click on the update link in the feed menu.
+
+![Feed menu](../img/users/refresh.2.png)
## Automatic update with cron
@@ -25,19 +58,19 @@ To do so, you need to create a scheduled task, which need to call a specific URL
Special parameters to configure the script - all parameters can be combined:
-* Parameter "force"
+- Parameter "force"
<https://freshrss.example.net/i/?c=feed&a=actualize&force=1>
If *force* is set to 1 all feeds will be refreshed at once.
-* Parameter "ajax"
+- Parameter "ajax"
<https://freshrss.example.net/i/?c=feed&a=actualize&ajax=1>
Only a status site is returned and not a complete website. Example: "OK"
-* Parameter "maxFeeds"
+- Parameter "maxFeeds"
<https://freshrss.example.net/i/?c=feed&a=actualize&maxFeeds=30>
If *maxFeeds* is set the configured amount of feeds is refreshed at once. The default setting is "10".
-* Parameter "token"
+- Parameter "token"
<https://freshrss.example.net/i/?c=feed&a=actualize&token=542345872345734>
Security parameter to prevent unauthorized refreshes. For detailed Documentation see "Form authentication".
@@ -77,27 +110,25 @@ If your FreshRSS instance uses no authentication (public instance, default user)
<https://freshrss.example.net/i/?c=feed&a=actualize&maxFeeds=10&ajax=1>
-## Manual update
+## Feed configuration of “Do not automatically refresh more often than”
-If you can’t or don’t want to use the automatic method, you can update manually. There are two methods for updating all or some of the feeds.
+### Background
-### Complete update
+FreshRSS does not, by design, supports pull refreshes at frequencies higher than once every 15 minutes. But FreshRSS supports instant push (WebSub).
-This update occurs on all feeds. To trigger it, simply click on the update link in the navigation menu.
+FreshRSS is part of an RSS ecosystem. A typical reaction that we have seen from several servers is to simply ban by, IP, user-agent, or to remove their RSS feed altogether. Bad user behaviours affect the larger community.
-![Navigation menu](../img/users/refresh.1.png)
+### Default value
-When the update starts, a progress bar appears and changes while feeds are processed.
+The default value of “Do not automatically refresh more often than” is set in Configuration -> Archiving.
-![Progress bar](../img/users/refresh.5.png)
+The lowest global/default purposely cannot be set faster than every 20 minutes, to avoid wasting resources and make sure the RSS ecosystem remains sane.
-### Partial update
+### Individual feed configuration
-This update occurs on the selected feed only. To trigger it, simply click on the update link in the feed menu.
-
-![Feed menu](../img/users/refresh.2.png)
+Under the settings for individual feeds, you can go down to 15min.
---
Read more:
-* [Normal, Global and Reader view](./03_Main_view.md)
-* [Filter the feeds and search](./10_filter.md)
+- [Normal, Global and Reader view](./03_Main_view.md)
+- [Filter the feeds and search](./10_filter.md)