From b43288c544b77bc4a7ec349c9cd8f48a2523570b Mon Sep 17 00:00:00 2001 From: git Date: Mon, 13 Nov 2023 13:09:02 +0100 Subject: [PATCH] README.md --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..06d3630 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Someone's privileged Mattermost scripts. ++ Copyright (c) 2016-2022 by Someone (aka. Jan Vales ) ++ published under MIT-License ++ These scripts need DB- and Filesystem-access. + +Beware: These scripts run regularily and are well tested. BUT by using these scripts, MM inc. may refuse to help you, if you run into (unrelated) issues with your MM. + +It all started with me starting to write my own DB+FS cleaner, after posting this: [https://mattermost.uservoice.com/forums/306457/suggestions/15357861](https://mattermost.uservoice.com/forums/306457/suggestions/15357861) +But eventually grew to include other scripts too. + +consider running as cronjobs: + + 00 23 * * * (cd /srv/mattermost/mattermost-privileged; git pull --recurse-submodules=yes; git gc) &>/dev/null + 55 23 * * * (cd /srv/mattermost/mattermost-privileged/maintenance; python3 -Bu db.py |tee /tmp/maintenance_db.log; python3 -Bu fs.py echo ""; du -sch /srv/mattermost/data/* | tail) + 59 11 * * MON (cd /srv/mattermost/mattermost-privileged/profile_badges; python3 -Bu main.py) + 0 0 * * 2-7 (cd /srv/mattermost/mattermost-privileged/stats; python3 -Bu main.py) + 0 0 * * MON (cd /srv/mattermost/mattermost-privileged/stats; python3 -Bu main.py week) + + +## maintenance ++ permanently deletes {"deleted",orphaned,old,unused} MM-db data and unreferenced files. ++ fix db-health degrading issues MM has (had?). ++ 'delete' System-Spam messages and "Posts marked for deletion" ++ enforce our system-policy (Can/must be enabled separately; Likely only makes sense for our instances) + + Deleting inactive Channels + Users/Guests. + +### **Beware: running this WILL break your instance's audit-trails. This IS intended behavior** + + +## profile_badges ++ Sets custom profile badges, needs DB access for post-count based badges. + + +## stats ++ various stats posted into channels. -- 2.43.0