NAME
BOTD - 24/7 channel daemon
SYNOPSIS
botctl <cmd> [key=value] [key==value]
DESCRIPTION
BOTD is a solid, non hackable bot, that runs under systemd as a 24/7 background service and starts the bot after reboot, intended to be programmable in a static, only code, no popen, no imports and no reading modules from a directory.
BOTD is programmable, to program the bot you have to have the code available as employing your own code requires that you install your own bot as the system bot. This is to not have a directory to read modules from to add commands to the bot but include the own programmed modules directly into the python code, so only trusted code (your own written code) is included and runnable. Reading random code from a directory is what gets avoided. As experience tells os.popen and __import__, importlib are also avoided.
BOTD stores it's data on disk where objects are time versioned and the last version saved on disk is served to the user layer. Files are JSON dumps that are read-only so thus should provide (disk) persistence more chance. Paths carry the type in the path name what makes reconstruction from filename easier then reading type from the object.
Only include your own written code should be the path to "secure".
INSTALL
sudo python3 -m pip install botd
sudo systemctl enable /usr/local//botd/botd.service --now
CONFIGURATION
icfg
command of the bot.irc
botctl icfg server=<server> channel=<channel> nick=<nick>
sasl
botctl pwd <nickservnick> <nickservpass>
botctl icfg password=<outputfrompwd>
users
botctl icfg users=True
botctl met <userhost>
rss
botctl rss <url>
the bot has the following commands:
$ botctl cmd
cmd,dlt,dne,dpl,flt,fnd,ftc,icfg,met,mre,nme,pwd,rem,rss,thr,upt,ver
here is a short description of the commands:
cmd
- shows all commandsdlt
- removes a user from botdne
- flag todo as donedpl
- sets display items for a rss feedflt
- shows a list of bot registered to the busfnd
- allows you to display objects on the datastore, read-only json files on diskftc
- runs a rss feed fetching batchicfg
- shows the irc configuration, also edits the configlog
- logs some textmet
- adds a users with there irc userhostmre
- displays cached output, channel wise.nme
- set name of a rss feedpwd
- combines a nickserv name/password into a sasl passwordrem
- removes a rss feed by matching is to its urlrss
- adds a feed to fetch, fetcher runs every 5 minutesthr
- show the running threadstdo
- adds a todo item, no options returns list of todo'supt
- show uptimever
- show versionAUTHOR
COPYRIGHT