cringebot/README.md

# cringebot
`cringebot` is a bot that tracks and auto-deletes on Mastodon/Pleroma accounts according to a set maximum age, if they are cringe enough. Tracking multiple accounts simultaneously is possible. Once a status is flagged as based, the bot will not touch it.

*Note: This software is still a little rough around the edges. If anybody but me actually wants to use this, I'll clean it up more, probably.*

## Installation (Linux)

#### Obtain root login shell
```
sudo -i
```

#### Install dependencies
```
apt install python3 bogofilter
pip3 install Mastodon.py html2text
```

#### Download cringebot and make user account
```
git clone https://git.thj.no/thor/cringebot.git /usr/local/lib/cringebot
useradd -d /usr/local/lib/cringebot -M -s /bin/bash -U cringebot
chown -R cringebot.cringebot /usr/local/lib/cringebot
```

#### Create configuration
```
cd /usr/local/lib/cringebot
cp config.example.json config.json
editor config.json
```

#### Install systemd service
```
ln -s cringebot.service /etc/systemd/system/cringebot.service
systemctl enable cringebot
systemctl start cringebot
```

#### Management
```
# Restart service
systemctl restart cringebot

# Check service status
systemctl status cringebot

# Monitor log output
journalctl -t cringebot -f
```

#### Learning

The bot will respond to each of your statuses with a categorisation status. Reply with `cringe` and `based` to teach the bot a categorisation, and `unlearn` to undo it. When the bot categorises or is taught that a message is cringe, it's scheduled for deletion `max_age` minutes after it was posted. When it's learned as based, or unlearned, it's removed from the deletion schedule.

## Maintainer

The maintainer can be contacted at `@thor@pl.thj.no`.