%META:TOPICPARENT{name="ODSIndex"}%
---+ Setting up <nop>PubSubHub in ODS

%TOC% 

---++ Introduction

<nop>PubSubHub (PSH) setup consists of two steps:

   1 Set up the ODS server.
   1 Configure applications to publish to hub. 

These steps are detailed below.

---++Prerequisites

The following packages should be installed:

   * <code>[[https://virtuoso.openlinksw.com/download/][ods_framework_dav.vad]]</code>
   * <code>[[https://virtuoso.openlinksw.com/download/][pubsubhub_dav.vad]]</code>
   * <code>[[https://virtuoso.openlinksw.com/download/][ods_blog_dav.vad]]</code>
   * <code>[[https://virtuoso.openlinksw.com/download/][ods_feedmanager_dav.vad]]</code>

---++ Set up the ODS server 

PSH setup on the ODS Server takes two steps, performed while logged in as the <code>dav</code> <nop>WebDAV System Administrator user, through the <b>Site Settings</b> link of ODS UI:

   1 In the <b>Feed Instances with Admin Rights</b> section , specify the PSH endpoint.  This setting tells applications what to report for PSH auto-discovery:
%BR%%BR%<img src="%ATTACHURLPATH%/step1.png" style="wikiautogen"/>%BR%%BR%
   2 The <b>Notification Services</b> UI is used to set up the PSH publish service endpoint, to which ODS users can point their applications:
%BR%%BR%<img src="%ATTACHURLPATH%/step2.png" style="wikiautogen"/>%BR%%BR%
      * Enter for Endpoint: <b><code><nowiki>http://&lt;host&gt;:&lt;port&gt;/psh/</nowiki></code></b> (modified for your instance, e.g., <b><code><nowiki>http://myhost.example.com:8889/psh/</nowiki></code></b>)
      * Enter for Notification Service: <b><code><nowiki>PubSubHub</nowiki></code></b>
      * Select Protocol: <b><code><nowiki>PubSubHub</nowiki></code></b>


ODS applications can now be configured to publish messages to the PSH endpoint.


---++ Configure an ODS application to publish via PSH

   1 Log in as the <b><code>dav</code></b> user.
   1 Go to <b>ODS</b> -> <b>Application Settings</b> -> <b>Application Notifications</b>
   1 Select the default 'dav' blog from the top menu, and highlight the <b>PubSubHub</b> Notification Service.  (You may command-click to select multiple notification targets.)
%BR%%BR%<img src="%ATTACHURLPATH%/step3.png" style="wikiautogen"/>%BR%%BR%
   1 Click <b>Add</b> to make your setting take effect.

---++ Test the setup using ODS-Feed Manager and basic PSH Subscription UI

For our test, we use ODS-Weblog as publisher and ODS-Feed Manager as subscriber.

First, in ODS-Feed Manager we subscribe to the rss feed:
   1 Log in as a normal user, e.g., <b><code>demo</code></b>
   1 Go to the Feed Manager application.
   1 Go to <b>Administration</b> -> <b>Feeds</b> and click <b>Subscribe</b>.
%BR%%BR%<img src="%ATTACHURLPATH%/p1.png" style="wikiautogen"/>%BR%%BR%
   1 Select <b>From URL...</b> and click <b>Next</b>.
   1 In <b>From URL (RSS/Atom/OPML/OCS/SIOC ...)</b> field, enter the Weblog Feed URL, e.g.,
<verbatim>
http://myhost.example.com/weblog/dav/dav-blog-0/gems/rss.xml
</verbatim>   
%BR%%BR%<img src="%ATTACHURLPATH%/p2.png" style="wikiautogen"/>%BR%%BR%
   1 Click <b>Subscribe</b>
%BR%%BR%<img src="%ATTACHURLPATH%/p3.png" style="wikiautogen"/>%BR%%BR%
   1 The PSH Server value will be shown, and <b>PubSubHub Enable</b> will be checked. Click <b>Subscribe</b> again.
%BR%%BR%<img src="%ATTACHURLPATH%/p4.png" style="wikiautogen"/>%BR%%BR%

Now, we publish something on the 'dav' weblog:
%BR%%BR%<img src="%ATTACHURLPATH%/p5.png" style="wikiautogen"/>%BR%%BR%
   
Notification is made to the PSH endpoint, and the Feed Manager is notified to update its subscription content.
%BR%%BR%<img src="%ATTACHURLPATH%/p6.png" style="wikiautogen"/>%BR%%BR%


---++Related

   * [[VirtPubSubHub][PubSubHubbub Demo Client Example]]
   * [[VirtFeedPubSubHub][Example feed subscription via PubSubHub Protocol]]
   * [[VirtPubSubHubACL][Setting Up PubSubHub to use WebID Protocol- or IP-based control lists]]
   * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtSPARQLEndpointProtection][Safeguarding your Virtuoso-hosted SPARQL Endpoint]]
   * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtTipsAndTricksGuideSPARQLEndpointProtection][SPARQL Endpoint Protection Methods Collection]]
   * [[http://docs.openlinksw.com/virtuoso/][Virtuoso documentation]]
      * [[http://docs.openlinksw.com/virtuoso/rdfsparql.html#rdfsupportedprotocolendpoint][SPARQL Service Endpoint]] 
      * [[http://docs.openlinksw.com/virtuoso/rdfsparql.html#rdfsupportedprotocolendpointuri][Service Endpoint Security]] 
      * [[http://docs.openlinksw.com/virtuoso/rdfsparql.html#sparqwebservicetbl][Managing a SPARQL Web Service Endpoint]] 
      * [[http://docs.openlinksw.com/virtuoso/rdfsparql.html][SPARQL]]
   * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtTipsAndTricksGuide][Virtuoso Tips and Tricks Collection]]
      * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtSPARQLDET][SPARQL Endpoint DET Configuration Guide]]       
      * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtSPARQLSecurityWebID][WebID Protocol & SPARQL Endpoint ACLs Tutorial]]
      * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtOAuthSPARQL][SPARQL OAuth Tutorial]]
      * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtTipsAndTricksGuideSPARQLEndpoints][Securing SPARQL endpoints]]
   * [[OdsSPARQLAuth][SPARUL over SPARQL using the http://cname:port/sparql-auth endpoint]]
   * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtAuthServerUI][Virtuoso Authentication Server UI]]
   * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtSPARQLSSL][Manage a SPARQL-WebID based Endpoint]]
   * [[VirtODSSecurityWebID][WebID Protocol Support in OpenLink Data Spaces]].
   * Manage ODS Datadspaces Objects WebID Access Control Lists (ACLs):
      * [[ODSBriefcaseWebID][ODS Briefcase WebID based ACL Guide]]
         * [[ODSBriefcaseWebIDPerson][Person Entity WebID based ACL Guide]]
         * [[ODSBriefcaseWebIDGroup][Group Entity WebID based ACL Guide]]
         * [[ODSBriefcaseWebIDPublic][Public WebID based ACL Guide]]      
      * [[ODSFeedManagerWebIDACL][ODS Feed Manager WebID based ACL Guide]]
         * [[ODSFeedManagerWebIDACLPerson][Person Entity Specific ACL]]
         * [[ODSFeedManagerWebIDACLGroup][Group Entity Specific ACL]]
         * [[ODSFeedManagerWebIDACLPublic][Public Specific ACL for anyone with a WebID]]
      * [[ODSCalendarWebIDACL][ODS Calendar WebID based ACL Guide]]
         * [[ODSCalendarWebIDACLPerson][Person Entity Specific ACL]]
         * [[ODSCalendarWebIDACLGroup][Group Entity Specific ACL]]
         * [[ODSCalendarWebIDACLPublic][Public Specific ACL for anyone with a WebID]]
      * [[ODSBookmarksWebIDACL][ODS Bookmark Manager WebID based ACL Guide]]
         * [[ODSBookmarksWebIDACLPerson][Person Entity Specific ACL]]
         * [[ODSBookmarksWebIDACLGroup][Group Entity Specific ACL]]
         * [[ODSBookmarksWebIDACLPublic][Public Specific ACL for anyone with a WebID]]
      * [[ODSAddressBookWebIDACL][ODS Addressbook  WebID based ACL Guide]]
         * [[ODSAddressBookWebIDACLPerson][Person Entity Specific ACL]]
         * [[ODSAddressBookWebIDACLGroup][Group Entity Specific ACL]]
         * [[ODSAddressBookWebIDACLPublic][Public Specific ACL for anyone with a WebID]]
   * [[ODSPkiSetup][Guide for Set up a X.509 certificate issuer and HTTPS listener and generate ODS user certificates]]
   * [[ODSSetupSSL][Configure Virtuoso+ODS instance as an X.509 Certificate Authority and HTTPS listener]]        
   * [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VirtSetupSSL][Configure Virtuoso instance as an X.509 Certificate Authority and HTTPS listener]]  
   * [[OdsKeyImport][CA Keys Import using Conductor]]
   * [[ODSGenerateX509Certificate][Generate an X.509 Certificate hosted WebID Guide]]
   * [[ODSGenerateWebIDX509CertOSKeystore][Generate an X.509 Certificate (with a WebID watermark) to be managed by host operating system keystore]]
   * [[ODSGenerateWebIDX509CertBrsKeystore][Generate an X.509 Certificate (with a WebID watermark) to be managed by a browser-based keystore]]
   * [[ODSWebIDIdP][Using Virtuoso's WebID Verification Proxy Service with a WebID-bearing X.509 certificate]]
   * [[ODSWebIDIdpProxy][Using Virtuoso's WebID Identity Provider (IdP) Proxy Service with an X.509 certificate]]
   * [[ODSBriefcaseWebIDShareFile][ODS Briefcase WebID Protocol Share File Guide]]
   * [[http://esw.w3.org/topic/foaf+ssl][WebID Protocol Specification]]
   * [[https://foaf.me/simpleLogin.php][Test WebID Protocol Certificate page]]
   * [[http://test.foafssl.org/cert/][WebID Protocol Certificate Generation page]]