$Id: README 1424 2006-03-13 20:33:10Z kreator $

README
======

INFO:
Hybserv2 is a new and improved version of the now unsupported Hybserv,
sporting new features, bugfixes, and more.  It is specifically designed
for Hybrid IRC servers, but may work with others as well. It includes
OperServ, NickServ, ChanServ, MemoServ, StatServ, HelpServ, and Global.
Each of the services can be enabled and disabled as necessary.

Hybserv was specifically designed to run with Hybrid6/7 ircd, although it
*should* work with Ratbox ircd and any other Hybrid-based ircd. You may
find the Hybrid IRC daemon at http://ircd-hybrid.com/. These services
(more or less same code) are currently used by several other networks such
as idolNET, BalcanNET, BGNet, BGFree, UniBG< BCNet, GunNet, ShakeIT,
FreeWorld, IRCBG, FreeNode/OPN.

The former Hybserv development team has decided to spin off and focus its
energy towards the Hybserv2 project. Like the name implies, this new
version is even better. If there is something you would like to see added
to Hybserv2, please let us know as we are always looking for fresh ideas.

NOTE: Per Sidewnder's (Cosine's) request - original Hybserv will no longer
      be supported.  So if you have questions or some problems, please
      *upgrade* first to a recent stable or even to a development version.

Hybserv was first coded by Patrick Alken (wnder|AT|underworld|net) and is
now maintained by the Hybserv2 Coding Team, unless otherwise mentioned in
the code or the Credits.

#########################################################

STAFF:
Lead developer of Hybserv2
kreator     Dinko Korunic        kreator|AT|srce|hr

The following people have contributed to Hybserv2 in blood and sweat
(nick alphabetical order):
adx         Piotr Nizynski       adx|AT|crashnet|pl
alex        Ales Tokic           ales|tokic|AT|gmail|com
args        Antoniu-George Savu  antoniu-george|savu|AT|fr|tiscali|com
asuffield   Andrew Suffield      asuffield|AT|users|sourceforge|net
bane        Dragan Dosen         ddosen|AT|ffzg|hr
bbrazil     Brian Brazil         bbrazil|AT|netsoc|tcd|ie
BEER_MAN    Ilian Jovchev        ilian|AT|irc|zonebg|com
Bruns       Brian Bruns          bruns|AT|magenet|net
CoolCold    Roman Ovchinnikov    coolcold|AT|coolcold|org
cosine      Patrick Alken        wnder|AT|uwns|underworld|net
ddb         Ivan Petrov          ddb|AT|xplovdiv|com
decho       Nedelcho Stanev      decho|AT|iname|com
fl_         Lee Hardy            lee|AT|leeh|co|uk
harly       Tomislav Novak       harly|AT|bofhlet|net
ike         Ivan Krstic          ike|AT|gnjilux|srk|fer|hr 
Janos       John Binder          jbinder|AT|kgazd|bme|hu
John-Work   F| John Rowan        john|AT|tdkt|org
knight      Alan Levee           alan|levee|AT|prometheus-designs|net
KrisDuv     Christophe Duverger  krisduv2000|AT|yahoo|fr
mend0za     Vladimir Shahov      mend0za|AT|nsys|by
MOLI        Olivier Molinete     olivier|AT|molinete|org
rhodie      Julian Petrov        rhodie|AT|irchelp|unibg|org
Sarisa      Wendy Campbell       wcampbel|AT|botbay|net
sofit       Stanislav Zahariev   sofit|AT|proshe|bg
t0sh        Todor Dimitrov       todor_p_dimitrov|AT|yahoo|com
toot        Toby Verrall         to7|AT|antipope|fsnet|co|uk

We are grateful to all these people, as well as all users that have been
reporting bugs last several years. Thank you, without you this project
would be meaningless.

#########################################################

DISTRIBUTION:
  You can get Hybserv2 from:

  1)  Hybserv2 home:
      http://www.hybserv.net/
      http://www.hybserv.net/wiki/HybservReleases

  2)  Anonymous Subversion access:
      svn co svn://svn.hybserv.net/trunk hybserv

  3)  Subversion Web access:
      http://www.hybserv.net/browser

  4)  Mirrors:
      http://dkorunic.net/projects/tarballs/
      http://www.hybserv.net/downloads/

NOTE: For each of these sites there is one in hybserv.net and one in
      hybserv2.net domain, for increased redundancy.

NOTE: Subversion copy is always more current than the release, since it is
      working/development version.

#########################################################

INSTALLATION:
Please read the INSTALL file. NOW.

#########################################################
 
RUNNING HYBSERV:
Make sure that each hub server you have specified in your config file has
C/N lines for Hybserv matching the password in the first field of the S:
line and the server name specified in the N: line. Also, if you wish to
enable jupes (#define ALLOW_JUPES), you *MUST* give services an H: line in
ircd.conf.

Configuration examples:

NOTE: Suppose the host name of services is "services.name" with
      an ip of 1.2.3.4, and that server accepting the services
      has name "server.shomewhere" with ircd class "server" (or
      class 1).

Required statements in ircd.conf for Hybrid5/6:

  C:1.2.3.4:password:services.name::1
  N:1.2.3.4:password:services.name::1
  H:*:*:services.name

NOTE: You can leave out H line if you don't want to use server
      jupes and G-Lines.

NOTE: We recommend using services on same server that is your
      hub, and then you can use 127.0.0.1 as address in C/N lines
      (which will give you some performance, since traffic will
      go through loop back device).

However in Hybrid7 to accomplish the same you have to put in ircd.conf
following code:

  connect {
    name = "services.name";
    host = "1.2.3.4";
    send_password = "password";
    accept_password = "password";
    compressed = no;
    hub_mask = "*";
    class = "server";
  };


In hybserv.conf configuration should be as follows:

  S:password:hub.server.somewhere:6667
  N:services.name:Hybrid services

When you have compiled Hybserv and edited the necessary files, simply type
./hybserv which should start daemon properly. If it is not in process
list, check hybserv.log which should state reasons of failure. 

Then, go on IRC and type:
  /msg OperServ identify <password>

Assuming OperServ is the OperServNick defined in settings.conf and you
have given yourself a O: line in hybserv.conf. You should be allowed to
give OperServ commands through /msg or DCC CHAT.

For a list of commands do:
  /msg OperServ help

Most commands may also be done through DCC CHAT, and in fact more commands
are available through DCC CHAT. Simply /dcc chat OperServ to connect, and
.help

I have tried to make Hybserv fully compatible with TCM (linking wise). If
you wish Hybserv to be part of your TCM botnet, read TCM-LINKING for
instructions. If you have no idea what a TCM bot is, don't worry about it
:-)

If you enabled NickServ, ChanServ, MemoServ etc. in config.h, you can get
lists of their commands through /msg *Serv help. NickServ and ChanServ
have several commands that can only be executed by administrators. This
means you must match an O: line (with an "a" flag) in hybserv.conf and be
registered with OperServ to use them. This can be done by typing /msg
OperServ password, these commands CANNOT be accessed by DCC Chat. 

NOTE: If you use Hybrid or Hybrid-compatible IRC daemon, you should enable
      Q-lines (quarantined nickname) for services-reserved nicknames
      because of obvious security reasons:

  Q:NickServ:This nickname is reserved.
  Q:ChanServ:This nickname is reserved.
  Q:OperServ:This nickname is reserved.

However Q lines changed in Hybrid7. Feel free to copy and paste these
lines:

  resv {
    # The reason must go first
    reason = "This nickname is reserved";
    nick = "NickServ";
    nick = "ChanServ";
    nick = "OperServ";
  };


################################################################

BUGS:
Use the appropriate bug reporting and ticketing system:

  #0:  http://www.hybserv.net/newticket

Alternative, subscribe to the mailing list (details follow) and post them
there.  We can't fix bugs if no one reports them!

################################################################

MAILING LISTS:
If you are interested in helping out with the development of Hybserv, or
just tracking the changes in Hybserv, feel free to join the Hybserv
Development List.

Here we can discuss anything we need and make sure problems get fixed.
Please feel free to give out this address, and you may subscribe by
sending email to:

  hybserv-request|AT|hybserv|net

NOTE: Please use a command from below in the body of the message and not
      in the subject. E-mail should corrected that "|AT|" is translated
      into "@" and rest of "|" characters are translated to ".", forming a
      correct destination.

Once subscribed, you can send a public post to:

  hybserv|AT|hybserv|net -- General mailing list

List manager interface is available at:

  ecartis|AT|hybserv|net -- List manager interface

The following commands are available:

  subscribe
        Syntax: subscribe [<list>] [<user>]
        Subscribe to a list                                                   

  unsubscribe
        Syntax: unsubscribe [<list>] [<user>]
        Unsubscribe from a list      

  which
        Syntax: which
        Display lists to which you are subscribed
        
  who
        Syntax: who [<list>]
        Display membership for a list

  info
        Syntax: info [<list>]
        Retrieves the info for a list.

  lists
        Syntax: lists
        Send list of mailing lists available on this site.

  help
        Syntax: help
        Send user the helpfile

  commands
        Syntax: commands
        Send list of available commands, providing a 'cheat sheet' for
        users. This takes into account any local plugins. 

  end
        Syntax: end
        Ends processing of list server commands       

################################################################

LEGAL STUFF:
This package has absolutely no warranty. Use at your own risk.  The author
will accept no responsibility for any damage, whatsoever, caused by this
program.

This software is released under the terms of the GNU General Public
License (see COPYING). Should you choose to use and/or modify any of code,
please do so under the terms of the GNU General Public License, published
by the Free Software Foundation.


################################################################

CREDITS:
Functions used from other GPL'd sources:
     match()        -- from ircd-hybrid source
     HashNick()     -- from ircd-hybrid source
     HashChannel()  -- from ircd-hybrid source

tools/mkpasswd.c is copyright (C) 1991 Nelson Minar
<minar|AT|reed|edu>, W. Campbell, and Hybrid7 team.

Some help files were used from EsperNet's service package:

  ftp.dragonfire.net/software/unix/irc

The ideas for a settings.conf and the shownicks/showchans programs were
inspired from this package as well. 

See also the beginning of this file.