diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/img/users/anonymous_access.1.png | bin | 28762 -> 8982 bytes | |||
| -rw-r--r-- | docs/en/img/users/token.1.png | bin | 28656 -> 0 bytes | |||
| -rw-r--r-- | docs/en/img/users/token.png | bin | 0 -> 14281 bytes | |||
| -rw-r--r-- | docs/en/users/09_refreshing_feeds.md | 34 |
4 files changed, 17 insertions, 17 deletions
diff --git a/docs/en/img/users/anonymous_access.1.png b/docs/en/img/users/anonymous_access.1.png Binary files differindex 58e4e113e..848c231cc 100644 --- a/docs/en/img/users/anonymous_access.1.png +++ b/docs/en/img/users/anonymous_access.1.png diff --git a/docs/en/img/users/token.1.png b/docs/en/img/users/token.1.png Binary files differdeleted file mode 100644 index 73ce65cf3..000000000 --- a/docs/en/img/users/token.1.png +++ /dev/null diff --git a/docs/en/img/users/token.png b/docs/en/img/users/token.png Binary files differnew file mode 100644 index 000000000..8c9d3c218 --- /dev/null +++ b/docs/en/img/users/token.png diff --git a/docs/en/users/09_refreshing_feeds.md b/docs/en/users/09_refreshing_feeds.md index 94b689b0d..a99d826c1 100644 --- a/docs/en/users/09_refreshing_feeds.md +++ b/docs/en/users/09_refreshing_feeds.md @@ -7,9 +7,9 @@ To take full advantage of FreshRSS, it needs to retrieve new items from the feed - [Partial update](#partial-update) - [Automatic update with cron](#automatic-update-with-cron) - [Online cron](#online-cron) - - [For Form Authentication](#for-form-authentication) + - [For Form Authentication (Web form)](#for-form-authentication-web-form) - [For HTTP authentication](#for-http-authentication) - - [For No authentication None](#for-no-authentication-none) + - [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) @@ -59,33 +59,33 @@ 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 `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" + <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 configured amount of feeds is refreshed at once. The default setting is `10`. + <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` -<https://freshrss.example.net/i/?c=feed&a=actualize&token=542345872345734> -Security parameter to prevent unauthorized refreshes. For detailed Documentation see "Form authentication". +- Parameters `user` and `token` + <https://freshrss.example.net/i/?c=feed&a=actualize&user=alice&token=token123> + Security parameters that allow a user to refresh their feed when *Web form* authentication is set. For detailed Documentation see “Form authentication” below. -### For Form Authentication +### For Form Authentication (Web form) -If your FreshRSS instance is using Form Authentication, you can configure an authentication token to grant access to the online cron. +If your FreshRSS instance is using Form Authentication, you can configure a *Master authentication token* in a user profile to grant access to the online cron. - + -You can target a specific user by adding their username to the query string, with `&user=insert-username`: +After setting the authentication token, use the `user` and `token` parameters to call the online cron script. For the above example, the syntax for the scheduled task will look as follows: -The scheduled task syntax should look as follows: +<https://freshrss.example.net/i/?c=feed&a=actualize&maxFeeds=10&ajax=1&user=alice&token=token123> -<https://freshrss.example.net/i/?c=feed&a=actualize&maxFeeds=10&ajax=1&user=someone&token=my-token> - -Alternatively, but not recommended, if you configure the application to allow anonymous reading, you can also allow anonymous users to update feeds (“Allow anonymous refresh of the articles”), and that does not require a token. +Alternatively, but not recommended, you can also allow anonymous users to update feeds (*Allow anonymous refresh of the articles*), and that does not require a token.  +This allows anyone to update the feeds of the default user’s subscriptions. + ### For HTTP authentication If your FreshRSS instance is using HTTP authentication, you’ll need to provide your credentials to the scheduled task. |
