first work on feed updater + pinger
[stapibas.git] / README.rst
1 ********
2 stapibas
3 ********
4 The standalone Pingback server, written in PHP.
5
6
7
8 =================
9 Pingback receiver
10 =================
11 stapibas receives pingbacks for your website and puts them into a database.
12
13
14 Setup
15 =====
16 Let your website send out the following HTTP header::
17
18   X-Pingback: http://stapibas.example.org/xmlrpc.php
19
20 That's all.
21
22
23 ===============
24 Pingback sender
25 ===============
26 stapibas is able to send pingbacks out to other websites at behalf of
27 your website.
28
29 It does this by watching your website's Atom feed.
30 Whenever it changes, it fetches the articles that are new or got updated and
31 sends out pingbacks to the remote websites.
32
33
34 Setup
35 =====
36 Insert your feed URL in the ``feeds`` database table.
37
38 Whenever you update your website, tell stapibas about it via a
39 HTTP POST request::
40
41   $ curl -d url=http://example.org/feed/ http://stapibas.example.org/request-feed-update.php