diff options
-rw-r--r-- | UpdatingFeeds.md | 76 |
1 files changed, 76 insertions, 0 deletions
diff --git a/UpdatingFeeds.md b/UpdatingFeeds.md new file mode 100644 index 0000000..e4f9b35 --- /dev/null +++ b/UpdatingFeeds.md @@ -0,0 +1,76 @@ +Updating Feeds +============== + +You have to setup one of this methods before you can start using tt-rss +properly, otherwise your feeds won’t be updated. + +Run update daemon if you are allowed to run background processes on your +tt-rss machine. Otherwise, use one of the other methods. On Debian, +official packages have cronjob-based updating setup out of the box. + +Update daemon +------------- + +**This is the recommended way to update feeds**. Please use it if you +have access to PHP CLI interpreter and can run background processes. You +can run single-process update daemon or update\_daemon2.php +(multi-process, runs several update tasks in parallel) using PHP cli +interpreter. + +Please do not ever run update daemon or any PHP processes as root. It is +recommended, but not required, to run the daemon under your website user +id (usually www-data, apache or something like that) to prevent file +ownership issues. + +Run: <code>php ./update.php —daemon</code> (single process) or <code>php +./update\_daemon2.php</code> (multi-process) + +The script doesn’t daemonize (e.g. detach from the terminal). You can +force it into background using external utility like start-stop-daemon +in Debian. Alternatively, you can run it under screen. + +Forking update daemon **requires** <code>PHP\_EXECUTABLE</code> being +configured correctly in <code>config.php</code> and pointing to PHP CLI +interpreter on your system, otherwise it won’t be able to run update +tasks. + +Periodical updating from crontab, using update script (update.php —feeds) +------------------------------------------------------------------------- + +Use this if you have access to PHP command line interpreter but not +allowed (e.g. by your hosting provider) to run persistent background +processes. Do not try to run cronjobs with a PHP CGI binary, it’s not +going to work. If you see HTTP headers being displayed when you run +<code>php ./update.php</code> you are using an incorrect binary. + +Full example (see man 5 crontab for more information on the syntax): + + */30 * * * * /usr/bin/php /home/user/public_html/tt-rss/update.php --feeds --quiet + +Notes: + +- <code>/usr/bin/php</code> should be replaced with the correct path + to PHP CLI binary on your system. If you are not sure which binary + or what path to use, ask your hosting provider. +- <code>/home/user/public\_html/tt-rss</code> stands for the directory + where you installed Tiny Tiny RSS. +- Try the command using shell if possible to check if it works before + setting up the cronjob. + +Simple background updates (since version:1.7.0) +----------------------------------------------- + +If all else fails and you can’t use any of the above methods, you can +enable simple update mode where tt-rss will try to periodically update +feeds while it is open in your web browser. Obviously, no updates will +happen when tt-rss is not open or your computer is not running. + +To enable this mode, set constant <code>SIMPLE\_UPDATE\_MODE</code> to +<code>true</code> in <code>config.php</code>. + +Note that only main tt-rss UI supports this, if you have digest or +mobile open or use an API client (for example, android application), +feeds are not going to be updated. You absolutely have to have tt-rss +open in a browser tab on a running computer somewhere. + +See also: [[UpdatingFeedsObsolete]] |