cogXWiki Hubot Integration
TypeXAR
Developed by

ldubost

Active Installs1
Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

Tested with XWiki 7.4.2

Installable with the Extension Manager

Description

This is the home of the XWiki Hubot Integration page, which allows to integrate XWiki with Matrix, Slack, IRC and other chat systems. For now the integration has been tested with Matrix.

Features available

This application provides:

  • Notifications sent to chat channels (either a global channel, or a channel for a specific space or a specific page)
  • Search XWiki from the chatbot.
  • (Matrix only) Automatically display the chat interface and create chat channels for XWiki page 

To send messages to a specific channel for a page or a space, edit the page or space in object mode (Edit Object in Advanced mode) and add the Hubot.ChannelClass to the page. Once you have added the object, you can edit the "channel" field and indicate the proper channel. For Matrix the channel is in the form "!someid:matrix.org". You can get this ID in your chat client when viewing channel information.

To automatically create a Matrix chat you need the skin additions (described below). You should see a new tab next to the "Comments" tab and be able to create a chat-room from this Tab.

Installation

To install and configure this application:

1/ Install Hubot and create your chat bot
2/ Add the XWiki Hubot Script xwiki.coffee and start hubot with the proper environment variables and the proper adaptor
3/ Install the XWiki Hubot Integration Application (in each wiki, if you are using multiple wikis)
4/ Configure the XWiki Hubot Integration Application in the Main wiki
5/ (Only for Matrix) Add docextra.vm and matrix.vm to your Skin page (it can be XWiki.DefaultSkin if you have not changed it)

Hubot Environment Variable

Here is the list of environment variables necessary:

export HUBOT_MATRIX_HOST_SERVER=https://matrix.org
export HUBOT_MATRIX_PASSWORD=YOURMATRIXUSERPASSOWORD
export XWIKI_USERNAME=YOURXWIKIUSER
export XWIKI_PASSWORD=YOURXWIKIPASSWORD
export HUBOT_LOG_LEVEL=debug
export EXPRESS_PORT=8001
./bin/hubot -a matrix

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Release Notes

v1.0

Version 1.0 supports:

  • Notifications from XWiki to hubot (all wiki, per space or page)
  • Search XWiki from the bot
  • (Matrix only) Show chatroom corresponding to a page in XWiki and automatically create chatroom for a page
Tags:
Created by Vincent Massol on 2017/06/13 08:45
    

Get Connected