 |
improve README - pubsubhubbubblub - pubsubhubbub client implementation |
 |
git clone git://git.codemadness.org/pubsubhubbubblub |
 |
Log |
|
Files |
|
Refs |
|
README |
|
LICENSE |
|
--- |
|
commit 942b1e6bd013eee6321334f11651e3982e491d83 |
|
parent a9f9a229d5be860a5fdab051fbda7ece66d2dd64 |
|
Author: Hiltjo Posthuma <[email protected]> |
|
Date: Sat, 28 May 2022 12:17:42 +0200 |
|
|
|
improve README |
|
|
|
Diffstat: |
|
M README | 48 ++++++++++++++++++++++-------… |
|
|
|
1 file changed, 34 insertions(+), 14 deletions(-) |
|
--- |
|
diff --git a/README b/README |
|
@@ -2,7 +2,7 @@ pubsubhubbubblub |
|
---------------- |
|
|
|
Generic pubsubhubbub client implementation. |
|
-Helper scripts to use it with sfeed. |
|
+It has some helper scripts to use it with RSS/Atom feeds and with sfeed. |
|
|
|
|
|
What is it |
|
@@ -23,25 +23,43 @@ Features |
|
Dependencies |
|
------------ |
|
|
|
-- C compiler |
|
+- C compiler (C99). |
|
+- libc (recommended: C99 and POSIX >= 200809). |
|
+ |
|
+ |
|
+Optional dependencies |
|
+--------------------- |
|
+ |
|
+- POSIX make(1) for the Makefile. |
|
+- POSIX sh(1), used by pubsub_setup. |
|
+- curl(1) binary: https://curl.haxx.se/ , |
|
+ used by pubsub_setup for subscribing and unsubscribing to a hub. |
|
|
|
|
|
Files |
|
----- |
|
|
|
-pubsub_cgi.c - Small stupid PubSubHubBub implementation as a CGI program. |
|
-pubsub_gethub - Helper program extract a hub and feed URL from a RSS or At… |
|
-pubsub_setup - Helper script that sets up the directory structure for |
|
- processing the feed for the CGI program. It has an |
|
- -s option to subscribe and an -u option to unsubscribe at … |
|
+pubsub_cgi.c - Small stupid PubSubHubBub implementation as a CGI program. |
|
+pubsub_gethub - Helper program extract a hub and feed URL from a RSS or Atom f… |
|
+pubsub_setup - Helper script that sets up the directory structure for |
|
+ processing the feed for the CGI program. It has an |
|
+ -s option to subscribe and an -u option to unsubscribe at a hu… |
|
|
|
|
|
How to install |
|
-------------- |
|
|
|
-For the CGI program: |
|
+To build it run: |
|
+ |
|
+ make |
|
+ |
|
+Install: |
|
|
|
-OpenBSD httpd and slowcgi, httpd.conf: |
|
+ cp pubsub_gethub pubsub_setup /usr/local/bin |
|
+ cp pubsub_cgi /var/www/cgi-bin/pubsub |
|
+ |
|
+ |
|
+A configuration example for the CGI program using OpenBSD httpd and slowcgi, h… |
|
|
|
location "/pubsub/**" { |
|
request strip 1 |
|
@@ -49,14 +67,14 @@ OpenBSD httpd and slowcgi, httpd.conf: |
|
fastcgi socket "/run/slowcgi.sock" |
|
} |
|
|
|
-Compile cgi.c statically and copy it to /var/www/cgi-bin/pubsub |
|
+Compile pubsub_cgi.c statically and copy it to /var/www/cgi-bin/pubsub |
|
|
|
- Create a directory with write-access for the pubsub CGI program |
|
- /var/www/pubsub-data/feedname. The setup_feed.sh script can be used to crea… |
|
+ /var/www/pubsub-data/feedname. The pubsub_setup script can be used to create |
|
the directories. |
|
- Make sure to set the proper permissions for the CGI program (slowcgi) and |
|
HTTPd. |
|
-- The base name of the CGI script can be changed in the setup_feed.sh script. |
|
+- The base name of the CGI script can be changed in the pubsub_setup script. |
|
|
|
|
|
How does it work |
|
@@ -71,9 +89,9 @@ Directory structure: |
|
/pubsub-data/config/feedname/hub - The hub URL, for example http://pubsubhu… |
|
/pubsub-data/config/feedname/topic - hub.topic, the feed URL. |
|
/pubsub-data/config/feedname/secret - hub.secret for calculating the message d… |
|
- see Section 8 of Pubsubhubbub core 0.4. |
|
+ see Section 8 of Pubsubhubbub core 0.4 (… |
|
/pubsub-data/config/feedname/token - File containing a line with a secret tok… |
|
- is not easy guessable (by different hubs… |
|
+ is not easy guessable by different hubs … |
|
/pubsub-data/feeds/feedname/ - Directory containing processed messages. |
|
/pubsub-data/tmp/feedname/ - Temporary directory to process messages. |
|
Moves to the feeds/feedname directory on… |
|
@@ -90,7 +108,9 @@ Get the hub and feed URL: |
|
http://rss.slashdot.org/Slashdot/slashdot self |
|
http://pubsubhubbub.appspot.com/ hub |
|
|
|
+ |
|
Setup the feed for the CGI program: |
|
+ |
|
cd /var/www/pubsub-data |
|
pubsub_setup -s 'slashdot' 'http://pubsubhubbub.appspot.com/' 'http://… |
|
