xref: /plugin/matrixnotifier/README.md (revision dd7d8b2f2df443add798ba6e37902b4037de0b4c)
187fd18beSWilhelm von Thiele# DokuWiki Matrix Notifier
2*dd7d8b2fSWilhelm von ThieleNotify DocuWiki page events via [Matrix](https://matrix.org/)
387fd18beSWilhelm von Thiele
487fd18beSWilhelm von Thiele## Installation
587fd18beSWilhelm von Thiele
6c96cab09SWilhelm von ThieleDrop 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.
787fd18beSWilhelm von Thiele
887fd18beSWilhelm von Thiele## Configuration
987fd18beSWilhelm von Thiele
10c96cab09SWilhelm von ThieleThe plugin is configured via DocuWiki's *Configuration Settings* (Admin menu).
1187fd18beSWilhelm von Thiele
1287fd18beSWilhelm von Thiele### Required Settings
1387fd18beSWilhelm von Thiele
146a06320aSWilhelm von ThieleOption | Description
156a06320aSWilhelm von Thiele------ | -----------
166a06320aSWilhelm von Thielehomeserver | the Matrix home server to use, e.g. https://matrix.example.com/
176a06320aSWilhelm von Thieleaccesstoken | the access token for the Matrix account to use
186a06320aSWilhelm von Thieleroom | the internal ID for the Matrix room where to post the notifications
1987fd18beSWilhelm von Thiele
206a06320aSWilhelm von Thiele> 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`.
2187fd18beSWilhelm von Thiele
2287fd18beSWilhelm von Thiele## Credits
2387fd18beSWilhelm von Thiele
2487fd18beSWilhelm von ThieleWilhelm/ JPTV.club
2587fd18beSWilhelm von Thiele
26*dd7d8b2fSWilhelm von ThieleThis project was loosely forked from the *DokuWiki Discord Notifier* (https://github.com/zteeed/dokuwiki-discord-notifier).
27