diff --git a/README.md b/README.md index b585b3e..87db1f0 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,38 @@ # 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 (Ubuntu Linux) -## Installation (Linux) - -#### Obtain root login shell +#### Download cringebot and make user account ``` -sudo -i +useradd -d /usr/local/lib/cringebot -M -s /bin/bash -U cringebot +sudo -i -u cringebot +git clone https://git.thj.no/thor/cringebot.git ``` #### Install dependencies ``` apt install python3 bogofilter +sudo -i -u cringebot pip3 install Mastodon.py html2text ``` -#### Download cringebot and make user account +#### Create configuration ``` -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 +sudo -i -u cringebot +cp config.example.toml config.toml +editor config.toml ``` -#### Create configuration +#### Run from command line ``` -cd /usr/local/lib/cringebot -cp config.example.json config.json -editor config.json +sudo -i -u cringebot +python3 cringebot.py ``` #### Install systemd service ``` -ln -s cringebot.service /etc/systemd/system/cringebot.service +ln -s /usr/local/lib/cringebot/cringebot.service /etc/systemd/system/cringebot.service systemctl enable cringebot systemctl start cringebot ``` diff --git a/config.toml.example b/config.example.toml similarity index 100% rename from config.toml.example rename to config.example.toml