diff options
| author | 2023-11-08 20:24:24 +0100 | |
|---|---|---|
| committer | 2023-11-08 20:24:24 +0100 | |
| commit | 44a7c54a5a6afb72937425cee0d53610e440ec60 (patch) | |
| tree | 3814bd499c1d59af39620c07cabb2f805e4ca54a /docs/en/users/WebSub.md | |
| parent | 348028a29043b7d1d0f80544c44f0454b2c375c3 (diff) | |
Update WebSub documentation a bit (#5829)
* Update WebSub documentation a bit
* Marien prefers not to promote his hub too much :-)
Diffstat (limited to 'docs/en/users/WebSub.md')
| -rw-r--r-- | docs/en/users/WebSub.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/en/users/WebSub.md b/docs/en/users/WebSub.md new file mode 100644 index 000000000..e8499b8e5 --- /dev/null +++ b/docs/en/users/WebSub.md @@ -0,0 +1,26 @@ +# The WebSub protocol + +[WebSub](https://www.w3.org/TR/websub/) (formerly [PubSubHubbub](https://github.com/pubsubhubbub/PubSubHubbub)) is a standard protocol +to instantly receive (push) notifications when some new content is available on a remote server, +for instance when a new article is available via RSS / ATOM. + +FreshRSS supports WebSub natively. +Just like for the FreshRSS API to work from a mobile phone, supporting WebSub requires that your FreshRSS instance is routable (that is to say, with a public IP, that can be accessed from third-party servers). + +## Examples of feeds + +Many individual feeds and platforms already offer instant notifications through WebSub, such as: +[Friendica instances](https://friendi.ca), WordPress (from WordPress.com or with [an extension](https://wordpress.org/plugins/pubsubhubbub/)), Blogger sites, Medium sites, etc. + +## Test WebSub + +You can test that WebSub works properly in your FreshRSS instance with a service such as: + +* <http://push-tester.cweiske.de> + +## Add WebSub to your RSS / ATOM feeds + +Your CMS (e.g. WordPress) might already offer WebSub as an option. Otherwise, you can make a solution that notifies a hub such as: + +* <https://websubhub.com> +* <https://pubsubhubbub.appspot.com> |
