Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 3 KB

README.md

File metadata and controls

61 lines (42 loc) · 3 KB

CircleCI Quality Gate Status Codacy Badge License

Apache Sling CMS - Disqus Plugin

A plugin to enable disqus comments in the Apache Sling CMS.

Installation

Download the build the code or latest release and install it into an Apache Sling CMS instance via the OSGi console at {sling_cms_host}/system/console/bundles.

Configuration

To use this plugin, you must enable it in the Component Policy you want in Sling CMS and configure the Component Policy with your Disqus Comments configuration.

The configuration includes the following fields:

  • Disqus Short Name (required) - Your Disqus shortName
  • Page URL Prefix (optional) - A prefix for generating the URL for the discussion, by default the mapped relative URL will be used
  • Page URL Suffix (optional) - A suffix for generating the URL for the discussion, .html will be used by default

Use

Once the Disqus Comments component is configured, you can add it to any page by selecting + then Disqus > Disqus Comments.

You can also edit the Disqus Comments component to override the generated URL, however this is not required.

The component can also be included from any other component using the following code:

<sling:include path="{some_path}" resourceType="com-danklco/disqus/components/disqus-comments" />

Building

This project requires Apache Maven 3 and Java JDK8. To build the project run:

mvn clean install

To install the bundle into a local Sling CMS instance running on port 8080, run:

mvn clean install -P autoInstallBundle