X-Git-Url: https://git.cweiske.de/stapibas.git/blobdiff_plain/39388c3f927ceb1ff508b4c759c1199b96acb2b0..06e27411941eb4dc1eb77688d710b048a95be7b1:/README.rst diff --git a/README.rst b/README.rst index 47954d0..108c90c 100644 --- a/README.rst +++ b/README.rst @@ -3,7 +3,27 @@ stapibas ******** The standalone Pingback server, written in PHP. +Alternative to `Trackback ‘em All`__ +__ http://scott.yang.id.au/code/trackback-em-all/ + + +============ +Dependencies +============ +- PHP 5.3+ +- PDO +- `Console_CommandLine`__ +- `Net_URL2`__ +- `HTTP_Request2`__ +- `PEAR2 Services_Pingback`__ +- `SimplePie`__ + +__ http://pear.php.net/package/Console_CommandLine +__ http://pear.php.net/package/Net_URL2 +__ http://pear.php.net/package/HTTP_Request2 +__ https://github.com/pear2/Services_Pingback +__ http://simplepie.org/ ================= Pingback receiver @@ -39,3 +59,13 @@ Whenever you update your website, tell stapibas about it via a HTTP POST request:: $ curl -d url=http://example.org/feed/ http://stapibas.example.org/request-feed-update.php + + +Run the pinger +============== +Run stapibas every 5 minutes or every hour to check for feed updates, +extract new URLs from the feed and send pingbacks to them. + +:: + + $ php bin/stapibas