Quak

a jabber component framework and application

 

Download

Feedback

Documentation

NAME

quak - a jabber component (framework)

VERSION

0.2

SYNOPSIS

quak.pl [/path/to/config_file]

DESCRIPTION

Quak is a simple jabber component (framework).

It connects to a jabber server as a component and acts like a normal bot.

You can add plugins to make the bot react on several events.

DEPENDENCIES

  • Net::XMPP
  • Net::Jabber
  • DBI

INSTALLATION

perl Makefile.PL
make install

CONFIGURATION

By default, quak uses /etc/quak.conf as config file.

Configuration directives:

  • domain = jabber.yourdomain.example

    the jabber server/domain

  • me = quak.jabber.yourdomain.example

    how quak should name itself

  • component = component.jabber.yourdomain.example

    the component name

  • port = 5275

    port to connect to

  • secret = yoursupersecret

    the component's password

  • quakuser = user

    user to run quak as

  • quakgroup = group

    group to run quak as

  • logdir = /path/to

    path to directory where quak logs it's output

  • dbfile = /path/to/quak.db

    sqlite3 database file quak shall use

  • plugindir = /path/to/plugins

    path to plugin directory

  • plugins = list of plugins

    plugins to load