====== MatrixNotifier Plugin ======

---- plugin ----
description: A DokuWiki plugin that notifies a Matrix room of wiki edits
author     : TurtleWilly 
email      : 
type       : action
lastupdate : 2021-09-29
compatible : Hogfather
depends    : 
conflicts  : 
similar    : 
tags       : notification, matrix

downloadurl: https://github.com/TurtleWilly/dokuwiki-matrix-notifier/releases/download/v1.2/matrixnotifier-1.2.zip
bugtracker : https://github.com/TurtleWilly/dokuwiki-matrix-notifier/issues
sourcerepo : https://github.com/TurtleWilly/dokuwiki-matrix-notifier/
donationurl: 

screenshot_img : 
----

===== Installation =====

Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

Alternatively download the latest [[https://github.com/TurtleWilly/dokuwiki-matrix-notifier/releases|Release]] archive and install the plugin using the [[plugin:plugin|Plugin Manager]] or drop the extracted ''matrixnotifier'' directory from the archive under ''lib/plugins/'' in the DocuWiki installation. Refer for further information about manual installation to [[:plugins|Plugins]].

===== Configuration =====

After the installation the plugin is configured via DocuWiki's //Configuration Settings// (Admin menu).

=== Required Settings ===

  * ''homeserver'' - the Matrix home server to use, e.g. https://matrix.org/
  * ''accesstoken'' - the access token for the Matrix account to use
  * ''room'' - the internal ID for the Matrix room where to post the notifications

> With the standard Matrix client **Element** the accesss token can be found in the user account settings under ''Help & About > Advanced > Access Token''. The required internal room ID can be found in the options for the room under ''Advanced > Room Information''.


===== Change Log =====

{{rss>https://github.com/TurtleWilly/dokuwiki-matrix-notifier/releases.atom 5 }}