README.rst

   1 ********
   2 stapibas
   3 ********
   4 The standalone Pingback server, written in PHP.
   5
   6 Alternative to `Trackback ‘em All`__
   7
   8 __ http://scott.yang.id.au/code/trackback-em-all/
   9
  10
  11 ============
  12 Dependencies
  13 ============
  14 - PHP 5.3+
  15 - PDO
  16 - `Net_URL2`__
  17 - `HTTP_Request2`__
  18 - `PEAR2 Services_Pingback`__
  19 - `SimplePie`__
  20
  21 __ http://pear.php.net/package/Net_URL2
  22 __ http://pear.php.net/package/HTTP_Request2
  23 __ https://github.com/pear2/Services_Pingback
  24 __ http://simplepie.org/
  25
  26 =================
  27 Pingback receiver
  28 =================
  29 stapibas receives pingbacks for your website and puts them into a database.
  30
  31
  32 Setup
  33 =====
  34 Let your website send out the following HTTP header::
  35
  36   X-Pingback: http://stapibas.example.org/xmlrpc.php
  37
  38 That's all.
  39
  40
  41 ===============
  42 Pingback sender
  43 ===============
  44 stapibas is able to send pingbacks out to other websites at behalf of
  45 your website.
  46
  47 It does this by watching your website's Atom feed.
  48 Whenever it changes, it fetches the articles that are new or got updated and
  49 sends out pingbacks to the remote websites.
  50
  51
  52 Setup
  53 =====
  54 Insert your feed URL in the ``feeds`` database table.
  55
  56 Whenever you update your website, tell stapibas about it via a
  57 HTTP POST request::
  58
  59   $ curl -d url=http://example.org/feed/ http://stapibas.example.org/request-feed-update.php
  60
  61
  62 Run the pinger
  63 ==============
  64 Run stapibas every 5 minutes or every hour to check for feed updates,
  65 extract new URLs from the feed and send pingbacks to them.
  66
  67 ::
  68
  69    $ php bin/stapibas