matrix-tools

Sets of scripts using the Matrix Admin API and thus allowing the server administration.

Installation

These scripts require curl and jq packages.

Copy this repo and check exec rules on the shell scripts.

Configuration

Edit the configuration file mtx.conf and set the environment variables.

API access

To be able to use these scripts, you need an admin user of the server. Not to be confused with the admin status of room. See Synapse Admin API doc.

To get your token, open your client Element:

• Click on your name in the top left corner then "Settings".
• Click the "Help & About" tab (left side of the dialog).
• Scroll to the bottom and click the part of Access Token: .
• Copy your access token to a safe place, like a dot file set in configuration file.

Test your access with the script mtx-stats.sh.

Scripts

Name	Description
mtx-user-erase.sh	Deactivate user account and erase data
mtx-user-list.sh	List local user account (whitout guests
mtx-get-vers.sh	Get Matrix API version
mtx-notice.sh	Send server notice to users
mtx-purge-media.sh	Purge local and remote media
mtx-reset-pwd.sh	Reset user password
mtx-rm-dev.sh	Delete user device
mtx-room-members	List room members
mtx-stats.sh	Get user's media usage statistics

Note:

mtx-notice not working and need notice option enable in synapse configuration.

---

matrix-tools - Xala MIT