1# DokuWiki Matrix Notifier
2Notify DocuWiki page events via [Matrix](https://matrix.org/)
3
4## Example
5
6<img width="780" height="259" src="https://raw.githubusercontent.com/TurtleWilly/dokuwiki-matrix-notifier/master/documentation/example.png">
7
8## Installation
9
10Drop the `matrixnotifier` directory under `lib/plugins/` in the DocuWiki installation. Alternatively zip the `matrixnotifier` directory and then use DocuWiki's *Extension Manager* (Admin menu) to do a manual installation.
11
12## Configuration
13
14The plugin is configured via DocuWiki's *Configuration Settings* (Admin menu).
15
16### Required Settings
17
18Option | Description
19------ | -----------
20homeserver | the Matrix home server to use, e.g. https://matrix.example.com/
21accesstoken | the access token for the Matrix account to use
22room | the internal ID for the Matrix room where to post the notifications
23
24> 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`.
25
26## Credits
27
28Wilhelm/ JPTV.club
29
30This project was loosely forked from the *DokuWiki Discord Notifier* (https://github.com/zteeed/dokuwiki-discord-notifier).
31