Extension Discourse


Extension Basics

Title
Discourse
Name
ckanext-discourse
Type
Public extension
Description
The **Discourse** extension for CKAN seamlessly integrates a Discourse forum with a CKAN instance, fostering dataset-specific discussions.
CKAN versions
Download-Url (zip)
Last commit
6 years ago (2019-02-25 16:34:59)
Url to repo
Category
Content Management


Background Infos

Description (long)
Show details

How it works

A new topic is created in the Discourse forum (in a designated Category) for each dataset, organization, and group in the CKAN site. This will happen automatically the first time someone visits the CKAN dataset, org and group page and starts a discussion. Topic reply counts are also displayed in the appropriate listing pages.

This plugin also supports ckanext-datarequests and ckanext-showcase.

Setup Discourse

  1. Install Discourse (v1.6+)

    The recommended way is to use the official Docker image following these instructions.

    Also make sure to set up Discourse email integration properly before proceeding as its required for account creation and notification.

  2. Create a new Discourse user. This will be the user that will create the topics on Discourse for each CKAN entity that has commenting support (currently, commenting is supported on Dataset packages, Organizations, Groups, Showcase Items, Dataset requests).

To create a new user, go to “Admin” > “Users” > “Send Invites” and enter an email address. You may want to name the user so that its plainly evident its a bot (e.g. databot). After creating the bot user, be sure to verify its email so it can post.

  1. Create a new Discourse Category. This will contain all topics created for each CKAN dataset. To do so, go to the homepage and click on “Categories” > “New Category”. Enter a name and optionally the slug for your category (e.g. Open Data Talk). After creating a Category, go to the Category page and take note of the URL. You will need this to setup ckanext-discourse.

  2. Configure Embbedding. Go to “Admin” > “Customize” > “Embedding”. You must fill up the following fields:

    • Allowed Hosts: Add the domain (without the http:// bit) of your CKAN instance (e.g. data.myorg.com)
    • Post to Category: Name of
Version
Version release date
(not set)
Contact name
(not set)
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

Discourse

  1. Install Discourse (v1.6+)

    The recommended way is to use the official Docker image following these instructions.

    Also make sure to set up Discourse email integration properly before proceeding as its required for account creation and notification.

  2. Create a new Discourse user. This will be the user that will create the topics on Discourse for each CKAN entity that has commenting support (current

Plugins to configure (ckan.ini)
discourse If discourse embedding is desired for ckanext discourse showcase datarequests
CKAN Settings (ckan.ini)
DB migration to be executed
(not set)
<< back to Extensions