From 256c8613a4046931dcd28ab22b6aebe8752a98c2 Mon Sep 17 00:00:00 2001
From: Alexandre Alapetite <alexandre@alapetite.fr>
Date: Fri, 15 May 2015 03:21:36 +0200
Subject: First draft of PubSubHubbub

https://github.com/FreshRSS/FreshRSS/issues/312
Requires setting base_url in config.php.
Currently using the filesystem (no change to the database)
---
 data/PubSubHubbub/feeds/.gitignore   |  1 +
 data/PubSubHubbub/feeds/README.md    | 12 ++++++++++++
 data/PubSubHubbub/secrets/.gitignore |  1 +
 data/PubSubHubbub/secrets/README.md  |  4 ++++
 data/config.default.php              |  8 +++++---
 5 files changed, 23 insertions(+), 3 deletions(-)
 create mode 100644 data/PubSubHubbub/feeds/.gitignore
 create mode 100644 data/PubSubHubbub/feeds/README.md
 create mode 100644 data/PubSubHubbub/secrets/.gitignore
 create mode 100644 data/PubSubHubbub/secrets/README.md

(limited to 'data')

diff --git a/data/PubSubHubbub/feeds/.gitignore b/data/PubSubHubbub/feeds/.gitignore
new file mode 100644
index 000000000..150f68c80
--- /dev/null
+++ b/data/PubSubHubbub/feeds/.gitignore
@@ -0,0 +1 @@
+*/*
diff --git a/data/PubSubHubbub/feeds/README.md b/data/PubSubHubbub/feeds/README.md
new file mode 100644
index 000000000..15fa8e521
--- /dev/null
+++ b/data/PubSubHubbub/feeds/README.md
@@ -0,0 +1,12 @@
+List of canonical URLS of the various feeds users have subscribed to.
+Several feeds can share the same canonical URL (rel="self").
+Several users can have subscribed to the same feed.
+
+* ./base64url(canonicalUrl)/
+	* ./secret.txt
+	* ./base64url(feedUrl1)/
+		* ./user1.txt
+		* ./user2.txt
+	* ./base64url(feedUrl2)/
+		* ./user3.txt
+		* ./user4.txt
diff --git a/data/PubSubHubbub/secrets/.gitignore b/data/PubSubHubbub/secrets/.gitignore
new file mode 100644
index 000000000..2211df63d
--- /dev/null
+++ b/data/PubSubHubbub/secrets/.gitignore
@@ -0,0 +1 @@
+*.txt
diff --git a/data/PubSubHubbub/secrets/README.md b/data/PubSubHubbub/secrets/README.md
new file mode 100644
index 000000000..ad8158839
--- /dev/null
+++ b/data/PubSubHubbub/secrets/README.md
@@ -0,0 +1,4 @@
+List of secrets given to PubSubHubbub hubs
+
+* ./sha1(random + salt).txt
+	* base64url(canonicalUrl)
diff --git a/data/config.default.php b/data/config.default.php
index 8be203d36..80d331df7 100644
--- a/data/config.default.php
+++ b/data/config.default.php
@@ -11,9 +11,11 @@ return array(
 	# Used to make crypto more unique. Generated during install.
 	'salt' => '',
 
-	# Leave empty for most cases.
-	# Ability to override the address of the FreshRSS instance,
-	# used when building absolute URLs.
+	# Specify address of the FreshRSS instance,
+	# used when building absolute URLs, e.g. for PubSubHubbub.
+	# Examples:
+	# https://example.net/FreshRSS/p/
+	# https://freshrss.example.net/
 	'base_url' => '',
 
 	# Natural language of the user interface, e.g. `en`, `fr`.
-- 
cgit v1.2.3