awbot - Arch Linux Women IRC bot
awbot [config_options] git push <old_commit> <new_commit> <branch_name> �� awbot [config_options] git branch <new_branch_name>
awbot is a simple IRC robot which posts notifications of git events to an IRC channel. It is intended to be called from within git hooks or from scripts. OpenSSL is required to connect to an IRC server.
An example invocation from a post-receive hook on the Arch Women server:
read old new branch
awbot git push "$old" "$new" "$branch"The configuration file is /etc/awbot.conf. Configuration can be overridden on the command line by listing config_options.
- server=
-
The DNS address of the IRC server to connect to. Default value is given for freenode.
- port=
-
The port to connect to. This must be the port used for SSL connections.
- nick=
-
An IRC nick to use. Upon connection, if the nick is already in use the bot will generate alternative by appending an integer.
- pass=
-
The corresponding password for the IRC nick. This is optional and can be left blank if there is no password.
Be sure to give the correct password. The bot will ignore NickServ.
WARNING When overriden from the command line, the shell may store the password in a history file.
- ircname=
-
A name like a real name.
- ircuser=
-
A user name like one used for UNIX accounts. It is optional and if not specified the value for nick is used.
- channel=
-
The channel to join and post messages to.
awbot is copyrighted work. Use `git shortlog -s` to get a list of current authors and contributors and their contact information.
awbot is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.