gnu-social/plugins/OStatus
Diogo Cordeiro 8c0601816f [CORE] Move core plugins to a new modules directory
For reference (raised by rozzin in IRC):

* http://foldoc.org/module
* http://foldoc.org/library
* http://foldoc.org/plugin

As noted by XRevan86, modules are not necessarily non-essential.
As we will keep the modules directory in GS root [therefore, near to
plugins/], it is evidenced the difference between both.

This is a simple yet fundamental structural change. It doesn't change
functionality but makes clearer the way we understand GNU social's
internals.
2019-08-22 03:13:58 +01:00
..
actions disabling auto-backlog-importer on subscribe 2017-08-23 18:09:49 +02:00
classes preamble with newline for AtomPub output etc. 2017-08-05 10:42:38 +02:00
lib [REFACTOR] Added explicit return type to all instances of QueueHandler::handle 2019-08-11 01:11:41 +01:00
locale [CORE] Move core plugins to a new modules directory 2019-08-22 03:13:58 +01:00
scripts OStatus plugin - Merge some bug fixes by XRevan86 2019-04-20 23:27:46 +01:00
tests Change mentions of PuSH to WebSub 2017-05-01 11:04:27 +02:00
EVENTS.txt Moved Diaspora specific metadata to own plugin 2015-06-06 13:49:27 +02:00
OStatusPlugin.php [OStatus] Fix notice enqueue 2019-08-21 16:46:38 +01:00
README Change mentions of PuSH to WebSub 2017-05-01 11:04:27 +02:00

README

Plugin to support importing and exporting notices through Atom and RSS feeds.
The OStatus plugin concentrates on user-to-user cases for federating StatusNet
and similar social networking / microblogging / blogging sites, but includes
low-level feed subscription systems which are used by some other plugins.

Uses WebSub (previously named PubSubHubbub or PuSH) for push feed updates;
currently non-WebSub feeds cannot be subscribed unless an external
WebSub hub proxy is used.


Configuration options available:

$config['ostatus']['hub']
    (default internal hub)
    Set to URL of an external WebSub hub to use it instead of our internal hub
    for sending outgoing updates in user and group feeds.

$config['ostatus']['hub_retries']
    (default 0)
    Number of times to retry a WebSub send to consumers if using internal hub


Settings controlling incoming feed subscription:

$config['feedsub']['fallback_hub']
    To subscribe to feeds that don't have a hub, an external WebSub proxy hub
    such as Superfeedr may be used. Any feed without a hub of its own will
    be subscribed through the specified hub URL instead. If the external hub
    has usage charges, be aware that there is no restriction placed to how
    many feeds may be subscribed!

    $config['feedsub']['fallback_hub'] = 'https://superfeedr.com/hubbub';

$config['feedsub']['hub_user']
$config['feedsub']['hub_password']
    If using the fallback hub mode, these settings may be used to provide
    HTTP authentication credentials for contacting the hub. Default hubs
    specified from feeds are assumed to not require


For testing, shouldn't be used in production:

$config['ostatus']['skip_signatures']
    (default use signatures)
    Disable generation and validation of Salmon magicenv signatures

$config['feedsub']['nohub']
    (default require hub)
    Allow low-level feed subscription setup for feeds without hubs.
    Not actually usable at this stage, OStatus will check for hubs too
    and we have no polling backend. (The fallback hub option can be used
    with a 3rd-party service to provide such polling.)

Todo:
* better support for feeds that aren't natively oriented at social networking
* make use of tags/categories from feeds
* better repeat handling