Nzbirc/guide/configuration

From tiberious.org

Main_Page > Nzbirc > Guide > 3. Configuration

Previous section: 2. Installation

Contents 1 Guide Contents 2 3. Configuration 2.1 Detailed explaination 2.2 IRC 2.3 Admin 2.4 Modules 2.5 Hella Module 2.6 Newzbin Module 2.7 TvNZB Module

Guide Contents

1. Downloading
2. Installation
3. Configuration
4. Running
5. Using

3. Configuration

If you are running the software for the fire time, this step can be skipped, as it will be done automatically

To re-start the automatic configuration routines, type the following into linux:

nzbirc --first

or for windows users:

php nzbirc.php first

Detailed explaination

There are all the options in the config file that you will need (including all the modules), only a few are required to be changed to quickly setup the bot.

Changed items from the default are in bold

'...' items signify skipped content (its in the config file, but would just waste space here)

IRC

Mostly self explainatory, put your irc server settings here (currently only 1 server is allowed).

$config->irc = array (
    'myserver' => array (
        'host' => 'irc.newzbin.com',
        'port' => 6667,
        'password' => ,
        'nick' => '^nzb',
        'altNick' => '^nzb_v1',
        'name' => 'nzbirc, i\'m not lazy, i\'m efficient',
        'ident' => 'nzbirc',
        'channels' => array (
            '#mychan',
        ),
        'perform' => array (
        ),
    ),
);

If you do not have your own irc server, or an irc server to use, there is a large collection in internet land, more infomation from wikipedia.

Admin

Here are some admin settings, enter in your nickname to gain access to admin only commands.

$config->admin = array (
    'nick' => array (
        'tiberious',
    ),
    'only' => false,
);

Modules

All the modules have a similar set of configration options, mainly the publicCommand and privateCommand options. These options tell the bot which commands the bot should look for and respond publicly and privatly respectivly.

These options are part of regular expressions, so they include some special characters (such as ^ for beginning of the line, and $ for the end). More information can be found here.

these options tend to look something like:

    'publicCommand' => array (
        '^config',
        '^!config',
    ),
    'privateCommand' => array (
        '^@config',
    ),

what these actually mean is that the module will be called when the text config, !config or @config is at the beginning of a line. To change the publicCommand to something else, such as just !conf the following can be done:

    'publicCommand' => array (
        '^!conf',
    ),

Hella Module

If you use hellanzb, your xmlrpc hostname, port and password need to be entered in here.

$config->moduleConf['hella'] = array (
  ...
    'xmlrpc' => array (
        'hostname' => 'localhost',
        'port' => 8760,
        'password' => 'myxmlrpcpassword',
    ),
  ...
);

port 8760 is the default xmlrpc port that hellanzb uses, so that probably does not need to be changed.

Newzbin Module

These settings signify newzbin.com username and password settings, also how and where it saves .nzb files (usually the directory, your usenet program looks for new nzb files in)

$config->moduleConf['nzb'] = array (
  ...
    'nbLogin' => true,
    'login' => array (
        'username' => 'tiberious',
        'password' => 'newzbinpwd',
    ),
    'download' => array (
        'useHella' => false,
        'nzbPath' => '/home/ftp/nzb/parse/',
        'nickPreface' => false,
        'history' => 14,
        'useDNZB' => false,
    ),
  ...
);

TvNZB Module

Similar to the newzbin module, the download path should be set (only if you use this module and tvnzb.com [when its up])

$config->moduleConf['tvnzb'] = array (
  ...
    'download' => array (
        'nzbPath' => '/home/ftp/nzb/parse/',
        'nickPreface' => false,
    ),
  ...
);

Next section: 4. Running