Differences

This shows you the differences between two versions of the page.

--- plugin:feedaggregator [2015-12-17 05:56] – samwilson
+++ plugin:feedaggregator [2018-05-29 23:13] (current) – [Installation] Klap-in
@@ Line 2: / Line 2: @@
 ---- plugin ----
-description: A plugin for aggregating multiple news feeds onto a single wiki page.
+description: A plugin for aggregating multiple news feeds onto a single wiki page
 author     : Sam Wilson
 email      : sam@samwilson.id.au
 type       : syntax,action
 lastupdate : 2015-12-17
-compatible : 2015-08-10a,2014-09-29
+compatible : 2015-08-10a, 2014-09-29
 depends    :
 conflicts  :
@@ Line 13: / Line 13: @@
 tags       : rss, feed, news, simplepie, embed
-downloadurl: http://github.com/samwilson/dokuwiki-plugin-feedaggregator/zipball/master
+downloadurl: https://github.com/samwilson/dokuwiki-plugin-feedaggregator/zipball/master
-bugtracker : http://github.com/samwilson/dokuwiki-plugin-feedaggregator/issues
+bugtracker : https://github.com/samwilson/dokuwiki-plugin-feedaggregator/issues
-sourcerepo : http://github.com/samwilson/dokuwiki-plugin-feedaggregator/
+sourcerepo : https://github.com/samwilson/dokuwiki-plugin-feedaggregator/
 donationurl:
@@ Line 23: / Line 23: @@
 ===== Installation =====
-Install using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
-The actual retrieval of the feeds is done by browsing to ''http://example.org/dokuwiki?do=feedaggregator''. This URL should be pinged regularly by cron or some quasi-cron web service.
+The actual retrieval of the feeds is done by browsing to ''%%http://example.org/dokuwiki/?do=feedaggregator%%''. This URL should be pinged regularly by cron or some quasi-cron web service; see the //[[#Automating]]// section below for more information.
 ===== Usage =====
-See the plugin in action [[http://www.example.com|here]].
 Define the feeds to be included with one URL on each line:
@@ Line 42: / Line 40: @@
 For other configuration options, please see the plugin's section in your site's Configuration Manager.
+===== Automating =====
+The feed-update URL should be called regularly by a cron (or other task-scheduling) service. If you set up a system to do this, then you should set a ''token'' in the plugin configuration; this will prevent the possibility of other requests wasting system resources by also requesting this URL.
+An example cron entry looks like the following:
+* * * * curl --silent http://example.org/dokuwiki/?do=feedaggregator&token=tok123
+If you use an automated update system, then you can do away with ''%%~~NOCACHE~~%%'' in the page text and instead force-purge the cache after the update operation. To do this, add a second cron entry similar to the following:
+* * * * curl --silent http://example.org/dokuwiki/news?purge=true
 ===== Change Log =====
 {{rss>https://github.com/samwilson/dokuwiki-plugin-feedaggregator/commits/master.atom date}}