bryanpedini
/
RinTinTinBot
0
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
9 Commits
1 Branch
0 Tags
40 KiB
Go 95.8%
Shell 4.2%
 
 
master
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'master'
${ noResults }
Go to file
Bryan Joshua Pedini f126b83abd fixed README.md 4 years ago
.gitignore initial commit 4 years ago
.travis.yml added codecov support 4 years ago
LICENSE initial commit 4 years ago
README.md fixed README.md 4 years ago
config.go first code commit 4 years ago
config_test.go added tests cleanup 4 years ago
main.go first code commit 4 years ago
push.sh added push.sh (just a human helper, nothing fancy) 4 years ago

README.md

RinTinTin - a better GroupHelpBot for your network friend groups

Build: Passing codecov

Table of contents:

Introduction

RinTinTin is a group helper bot to manage a network of groups with the same settings, welcome message, rules, permissions and all alike.

It was mainly created for the lack of features and the unaddressed bugs present in GroupHelp, but then expanded to feature a more network-oriented approach for the Computer Science Italia network of friend groups.

Scope of the software

RinTinTin doesn't aim to be a I-Do-Your-Job bot, but rather a helper to address and automate common tasks such as muting, warning and banning of a user.

Installation

Prerequisites:

  • Mysql (or)
  • MariaDB (or)
  • PostgreSQL (or)
  • SQLite3 (defaults to ./data.db)

Prerequisites for running the Docker image:

  • Docker
  • Docker-Compose

One-Command-Installation (preferred method):

curl https://git.bjphoster.com/bryanpedini/RinTinTinBot/raw/branch/master/one-command-installer.sh -O - | sudo sh -

from inside the directory you want the bot to be running (prerequisite: curl)

Manual installation:
First, get the binary executable in the desired directory (prerequisite curl || wget, latter as default)

VERSION=<version> wget https://git.bjphoster.com/bryanpedini/RinTinTinBot/releases/download/`echo $VERSION`/RinTinTin-`echo $VERSION`-`uname -s`-`uname -m`-bin -O RinTinTin

Then, let the program generate the example configuration file, and adjust that as you see it fit your needs

./RinTinTin --generate-default-config

Now, optionally, install the custom service file to let the bot be ran at startup, quickly reloaded, and restarted (assuming systemd instead of init.d)

sudo wget https://git.bjphoster.com/bryanpedini/RinTinTinBot/raw/branch/master/conf/RinTinTin.service -O /usr/lib/systemd/system/RinTinTin.service