retry pinging only 5 times
[stapibas.git] / 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 - `Console_CommandLine`__
17 - `Net_URL2`__
18 - `HTTP_Request2`__
19 - `PEAR2 Services_Pingback`__
20 - `SimplePie`__
21
22 __ http://pear.php.net/package/Console_CommandLine
23 __ http://pear.php.net/package/Net_URL2
24 __ http://pear.php.net/package/HTTP_Request2
25 __ https://github.com/pear2/Services_Pingback
26 __ http://simplepie.org/
27
28 =================
29 Pingback receiver
30 =================
31 stapibas receives pingbacks for your website and puts them into a database.
32
33
34 Setup
35 =====
36 Let your website send out the following HTTP header::
37
38   X-Pingback: http://stapibas.example.org/xmlrpc.php
39
40 That's all.
41
42
43 ===============
44 Pingback sender
45 ===============
46 stapibas is able to send pingbacks out to other websites at behalf of
47 your website.
48
49 It does this by watching your website's Atom feed.
50 Whenever it changes, it fetches the articles that are new or got updated and
51 sends out pingbacks to the remote websites.
52
53
54 Setup
55 =====
56 Insert your feed URL in the ``feeds`` database table.
57
58 Whenever you update your website, tell stapibas about it via a
59 HTTP POST request::
60
61   $ curl -d url=http://example.org/feed/ http://stapibas.example.org/request-feed-update.php
62
63
64 Run the pinger
65 ==============
66 Run stapibas every 5 minutes or every hour to check for feed updates,
67 extract new URLs from the feed and send pingbacks to them.
68
69 ::
70
71    $ php bin/stapibas