From d3e858a3ed3e3b578f8ea8c066c84342f4ddbc54 Mon Sep 17 00:00:00 2001 From: PC-Admin Date: Sun, 20 Aug 2023 19:29:06 +0800 Subject: [PATCH] update README.md --- README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+) diff --git a/README.md b/README.md index f281224..bacea76 100755 --- a/README.md +++ b/README.md @@ -6,6 +6,64 @@ A Matrix moderation tool to make managing a Synapse server easier. Contact me at [@michael:perthchat.org](https://matrix.to/#/@michael:perthchat.org) if you get stuck or have an edit in mind. +*** +## List of Functions + +This tool abstracts the Synapse API so you can perform common moderation functions easier and in batch. + +Here is a preview of the CLI interface: +``` +########################## +# MATRIX MODERATION TOOL # +########################## + +A tool for making common Synapse moderation tasks easier. Created by @PC-Admin. + +---------------------------------------------- + +#### User Account Commands #### #### Room Commands #### +1) Deactivate a user account. 50) List details of a room. +2) Deactivate multiple user accounts. 51) List the members of a room. +3) Create a user account. 52) Export the state events of a room. +4) Create multiple user accounts. 53) Export the state events of multiple rooms. +5) Reset a users password. 54) List rooms in public directory. +6) Whois user account. 55) Remove a room from the public directory. +7) Whois multiple user accounts. 56) Remove multiple rooms from the public directory. +8) Query user account. 57) Redact a room event. +9) Query multiple user accounts. 58) List/Download all media in a room. +10) List room memberships of user. 59) Download media from multiple rooms. +11) Promote a user to server admin. 60) Quarantine all media in a room. +12) List all user accounts. 61) Shutdown a room. +13) Quarantine all media a users uploaded. 62) Shutdown multiple rooms. +14) Collect account data. 63) Delete a room. +15) List account pushers. 64) Delete multiple rooms. +16) Get rate limit of a user account. 65) Purge the event history of a room to a specific timestamp. +17) Set rate limit of a user account. 66) Purge the event history of multiple rooms to a specific timestamp. +18) Delete rate limit of a user account. 67) Get blocked status for room. +19) Check if user account exists. 68) Block a room. +20) Shadow ban a user. 69) Unblock a room. +21) Find a user by their 3PID. + +#### Server Commands #### #### ipinfo.io #### +100) Delete and block a specific media. 140) Analyse a users country of origin. +101) Purge remote media repository up to a certain date. 141) Analyse multiple users country of origin. +102) Prepare database for copying events of multiple rooms. +103) Show last 10 reported events. #### Report Generation #### +104) Get all reported events. 150) Generate user report. +105) Get details of a reported event. 151) Lookup homeserver admin contact details. + 152) Send a test email (to yourself). +#### rdlist - General #### 153) Send a test Matrix message (to yourself). +120) Block all rooms with specific rdlist tags. 154) Send test incident reports (to yourself). +121) Get rdlist tags for a room. + +#### rdlist - Recommended Tags #### +For rdlist rooms with recommended tags, the following actions are available: +130) Collect User Reports on local accounts in rdlist rooms. +131) Send Incident Reports on remote accounts in rdlist rooms. +132) Block/Purge all rdlist rooms. +``` + + *** ## Licensing