https://github.com/klcodanr/slingcms-disqus-plugin

An Apache Sling CMS plugin to embed Disqus comments
https://github.com/klcodanr/slingcms-disqus-plugin

apache-sling disqus

Last synced: 6 months ago
JSON representation

An Apache Sling CMS plugin to embed Disqus comments

• Host: GitHub
• URL: https://github.com/klcodanr/slingcms-disqus-plugin
• Owner: klcodanr
• License: apache-2.0
• Created: 2020-01-02T21:40:11.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2021-06-28T16:56:06.000Z (about 5 years ago)
• Last Synced: 2024-04-16T07:55:57.487Z (over 2 years ago)
• Topics: apache-sling, disqus
• Language: Java
• Size: 55.7 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


[![CircleCI](https://circleci.com/gh/klcodanr/slingcms-disqus-plugin.svg?style=svg)](https://circleci.com/gh/klcodanr/slingcms-disqus-plugin)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=slingcms-disqus-plugin&metric=alert_status)](https://sonarcloud.io/dashboard?id=slingcms-disqus-plugin)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8dc8e104315140f0b07cf494039a3160)](https://www.codacy.com/manual/klcodanr/slingcms-disqus-plugin?utm_source=github.com&utm_medium=referral&utm_content=klcodanr/slingcms-disqus-plugin&utm_campaign=Badge_Grade)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)

# Apache Sling CMS - Disqus Plugin

A plugin to enable [disqus](https://disqus.com) comments in  the

[Apache Sling CMS](https://github.com/apache/org-apache-sling-app-cms).

## Installation

Download the [build the code](#building) 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](https://github.com/apache/sling-org-apache-sling-app-cms/blob/master/docs/component-policy.md)

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](https://help.disqus.com/en/articles/1717111-what-s-a-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:

  ``

## 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`