aboutsummaryrefslogtreecommitdiff
path: root/data
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2015-05-15 03:21:36 +0200
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2015-05-15 03:21:36 +0200
commit256c8613a4046931dcd28ab22b6aebe8752a98c2 (patch)
tree2dbca039f47aec102a01e9a7d999fcfc26d294b4 /data
parentf4b0661f3db9f0bafb97636808ddc2274010d440 (diff)
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)
Diffstat (limited to 'data')
-rw-r--r--data/PubSubHubbub/feeds/.gitignore1
-rw-r--r--data/PubSubHubbub/feeds/README.md12
-rw-r--r--data/PubSubHubbub/secrets/.gitignore1
-rw-r--r--data/PubSubHubbub/secrets/README.md4
-rw-r--r--data/config.default.php8
5 files changed, 23 insertions, 3 deletions
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`.