Infrastructure/infra-docs-fpo
1
0
Fork 0
Code Issues 100 Pull requests 6 Projects Releases Packages Wiki Activity Actions

zodbot sop: rewrite, update, add info. fixes ticket #16

Browse source 
Signed-off-by: Kevin Fenzi <kevin@scrye.com>
This commit is contained in:
Kevin Fenzi 2022-03-18 13:02:30 -07:00 • committed by kevin
parent 3ced0ea55e
commit 63c719e397
1 changed files with 51 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

67
modules/sysadmin_guide/pages/zodbot.adoc
View file

@ -18,28 +18,21 @@ Owner::
Contact:: Contact::
#fedora-admin #fedora-admin
Servers:: Servers::
value01 value02
Purpose:: Purpose::
Provides our IRC bot Provides our IRC bot
== Description == Description
Zodbot is a supybot based irc bot that we use in our #fedora channels. Zodbot is a supybot based irc bot that we use in our #fedora channels.
It runs on _value01_ as the daemon user. We do not manage the It runs on _value02_ as the daemon user. We do not manage the
`zodbot.conf` because supybot makes changes to it on its own. Therefore it `zodbot.conf` because supybot makes changes to it on its own. Therefore it
gets backed up and is treated as data. gets backed up and is treated as data.
shutdown:: shutdown::
`killall supybot` `systemctl stop zodbot`
startup:: startup::
+ `systemctl start zodbot`
....
cd /srv/web/meetbot
# zodbot current needs to be started in the meetbot directory.
# This requirement will go away in a later meetbot
release
sudo -u daemon supybot -d /var/lib/zodbot/conf/zodbot.conf
....
== Startup issues == Startup issues
@ -65,9 +58,9 @@ This should allow the bot to connect again.
zodbot forgets about meetings if they are in progress when the bot goes zodbot forgets about meetings if they are in progress when the bot goes
down; therefore, the meetings never get processed. Users may request a down; therefore, the meetings never get processed. Users may request a
ticket in our Trac instance to have meeting logs processed. ticket in our pagure ticket instance to have meeting logs processed.
Trac tickets for meeting log processing should consist of a URL where pagure tickets for meeting log processing should consist of a URL where
zodbot had saved the log so far and an uploaded file containing the rest zodbot had saved the log so far and an uploaded file containing the rest
of the log. The logs are stored in `/srv/web/meetbot`. Append the of the log. The logs are stored in `/srv/web/meetbot`. Append the
remainder of the log uploaded to Trac (don't worry too much about remainder of the log uploaded to Trac (don't worry too much about
@ -75,10 +68,10 @@ formatting; `meeting.py` works well with irssi- and XChat-like logs), then
run: run:
.... ....
sudo python /usr/lib/python2.7/site-packages/supybot/plugins/MeetBot/meeting.py replay /path/to/fixed.log.txt sudo python /usr/lib/python3*/site-packages/supybot/plugins/MeetBot/meeting.py replay /path/to/fixed.log.txt
.... ....
Close the Trac ticket, letting the user know that the logs are processed Close the pagure ticket, letting the user know that the logs are processed
in the same directory as the URL they gave you. in the same directory as the URL they gave you.
== Becoming an admin == Becoming an admin
@ -90,7 +83,8 @@ Register with zodbot on IRC.:
.... ....
You have to identify to the bot to do any admin type commands, and you You have to identify to the bot to do any admin type commands, and you
need to have done so before anyone can give you privs. need to have done so before anyone can give you privs. zodbot has it's
own users database seperate from the account system.
After doing this, ask in #fedora-admin on IRC and someone will grant you After doing this, ask in #fedora-admin on IRC and someone will grant you
privs if you need them. You'll likely be added to the admin group, which privs if you need them. You'll likely be added to the admin group, which
@ -102,3 +96,44 @@ illustrating how to get the list of capabilities).
21:57 < zodbot> nirik: capability add, capability remove, channels, ignore add, 21:57 < zodbot> nirik: capability add, capability remove, channels, ignore add,
ignore list, ignore remove, join, nick, and part ignore list, ignore remove, join, nick, and part
.... ....
There's also a 'owner' power level that lets you have full privs on zodbot.
In order to add someone as a owner, they must make an account, then
zodbot must be stopped completely. The local zodbot.conf file on value02
edited and the user added as owner. The bot can then be restarted.
== Adding zodbot to another channel
Any owner or admin can ask zodbot to join another channel with the 'join' command.
In general we should ask people why they need it there and try and keep channels
minimal.
== zodbot plugins
Zodbot extends functionality via a number of plugins. Some of which are fedora specific.
=== supybot-fedora
This plugin interacts with the Fedora account system (noggin)
https://github.com/fedora-infra/supybot-fedora
=== supybot-meetbot
This plugin handles meeting functions.
https://github.com/fedora-infra/supybot-meetbot
=== supybot-koji
This plugin allows querying koji (the fedora build system)
https://github.com/fedora-infra/supybot-koji
== More information
zodbot is a https://github.com/progval/Limnoria bot, a reimplemetation of
the original supybot.
https://fedoraproject.org/wiki/Zodbot describes the commands users may wish to
use with zodbot as well as more general information.