README.rst

   1 ********
   2 stapibas
   3 ********
   4 The standalone Pingback server, written in PHP.
   5
   6 - Receives linkbacks (webmention and pingbacks)
   7 - Watches your website's Feed to send out linkbacks to all linked URLs
   8
   9 Alternative to `Trackback ‘em All`__
  10
  11 __ http://scott.yang.id.au/code/trackback-em-all/
  12
  13
  14 ============
  15 Dependencies
  16 ============
  17 - PHP 5.3+
  18 - PDO
  19 - `Console_CommandLine`__
  20 - `Net_URL2`__
  21 - `HTTP_Request2`__
  22 - `PEAR2 Services_Linkback`__
  23 - `SimplePie`__
  24
  25 __ http://pear.php.net/package/Console_CommandLine
  26 __ http://pear.php.net/package/Net_URL2
  27 __ http://pear.php.net/package/HTTP_Request2
  28 __ https://github.com/pear2/Services_Linkback
  29 __ http://simplepie.org/
  30
  31
  32 =================
  33 Pingback receiver
  34 =================
  35 stapibas receives pingbacks for your website and puts them into a database.
  36
  37 It also sends them as email to a configured address.
  38
  39
  40 Setup
  41 =====
  42 Let your website send out the following HTTP headers::
  43
  44   X-Pingback: http://stapibas.example.org/xmlrpc.php
  45   Header set Link '<http://stapibas.example.org/xmlrpc.php>; rel="webmention"'
  46
  47 That's all.
  48
  49
  50 ===============
  51 Pingback sender
  52 ===============
  53 stapibas is able to send pingbacks out to other websites at behalf of
  54 your website.
  55
  56 It does this by watching your website's Atom (or RSS) feed.
  57 Whenever it changes, it fetches the articles that are new or got updated and
  58 sends out pingbacks to the remote websites.
  59
  60
  61 Setup
  62 =====
  63 Add your feed URL::
  64
  65   $ ./bin/stapibas feed add http://example.org/feed.atom
  66
  67 Whenever you update your website, tell stapibas about it via a
  68 HTTP POST request, sending the feed URL::
  69
  70   $ curl -d url=http://example.org/feed.atom http://stapibas.example.org/request-feed-update.php
  71
  72 This tells stapibas to check this feed the next time the pinger runs.
  73
  74
  75 Run the pinger
  76 ==============
  77 Run stapibas every 5 minutes or every hour to check for feed updates,
  78 extract new URLs from the feed and send pingbacks to them.
  79
  80 ::
  81
  82    $ php bin/stapibas