README.md

   1 # Someone's privileged Mattermost scripts.
   2 + Copyright (c) 2016-2022 by Someone <someone@somenet.org> (aka. Jan Vales <jan@jvales.net>)
   3 + published under MIT-License
   4 + These scripts need DB- and Filesystem-access.
   5
   6 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.
   7
   8 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)
   9 But eventually grew to include other scripts too.
  10
  11 consider running as cronjobs:
  12
  13     00 23 * * *   (cd /srv/mattermost/mattermost-privileged; git pull --recurse-submodules=yes; git gc) &>/dev/null
  14     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)
  15     59 11 * * MON (cd /srv/mattermost/mattermost-privileged/profile_badges; python3 -Bu main.py)
  16     0 0 * * 2-7   (cd /srv/mattermost/mattermost-privileged/stats; python3 -Bu main.py)
  17     0 0 * * MON   (cd /srv/mattermost/mattermost-privileged/stats; python3 -Bu main.py week)
  18
  19
  20 ## maintenance
  21 + permanently deletes {"deleted",orphaned,old,unused} MM-db data and unreferenced files.
  22 + fix db-health degrading issues MM has (had?).
  23 + 'delete' System-Spam messages and "Posts marked for deletion"
  24 + enforce our system-policy (Can/must be enabled separately; Likely only makes sense for our instances)
  25   + Deleting inactive Channels + Users/Guests.
  26
  27 ### **Beware: running this WILL break your instance's audit-trails. This IS intended behavior**
  28
  29
  30 ## profile_badges
  31 + Sets custom profile badges, needs DB access for post-count based badges.
  32
  33
  34 ## stats
  35 + various stats posted into channels.