aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorGravatar Fake4d <Fake4d@users.noreply.github.com> 2019-04-29 10:35:28 +0200
committerGravatar GitHub <noreply@github.com> 2019-04-29 10:35:28 +0200
commit097d7718699af0a9d81368d7bf37538f5ca6fb7f (patch)
treec3a2a50d19b1b5ec584745942e3785d726002122 /docs
parent744a9e8cf00aef7dec0acfa5f90f0dcfa2ef8837 (diff)
Update 03_Main_view.md
Document all the parameters for "feed actualize". the new parameter "maxfeeds" from Pull Request #2388 is already considered.
Diffstat (limited to 'docs')
-rw-r--r--docs/en/users/03_Main_view.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/en/users/03_Main_view.md b/docs/en/users/03_Main_view.md
index 53d7131b6..9588063d7 100644
--- a/docs/en/users/03_Main_view.md
+++ b/docs/en/users/03_Main_view.md
@@ -30,6 +30,23 @@ Here is an example to trigger article update every hour.
0 * * * * php /path/to/FreshRSS/app/actualize_script.php > /tmp/FreshRSS.log 2>&1
```
+Special parameters to configure the script - all parameters can be combined:
+
+- 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"
+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"
+https://freshrss.example.net/i/?c=feed&a=actualize&maxfeeds=30
+If maxfeeds is set the confgured amount of feeds is refreshed at once. The default setting is "10".
+
+- Parameter "token"
+https://freshrss.example.net/i/?c=feed&a=actualize&token=542345872345734
+Security parameter to prevent unauthorized refreshs. For detailed Documentation see "Form authentication".
### Online cron