Cygnus -- INSTALL file

--

This document will guide you through the process of installing Cygnus.
For general information about this program, see the README file.

If you have any problems with the installation procedure, or need
help with the general operation of this program, ask in #Services
on HabberNet (irc.habber.net).

-----

Installation is a fairly easy procedure. Begin with the configure
script. In most cases, you can run it with a command like:

./configure

The configure script will ask you where you want to install to, and
whether or not you want to run the database converter.

After these questions, the configure script will run several tests,
write several files, and exit. You should check inc/config.h for any
items that you want to change for your network. Once you are done with
config.h, you can begin compiling Cygnus. To do this, simply type:

make

The program will compile. When it's done, type:

make install

The newly compiled binary and several supporting files will be copied to
the directory you gave the configure script.

If you answered "Yes" to the database conversion question during
configure, the db converter will now run. It will ask you where your
existing DBs are, and will then attempt to read and convert them. Don't
worry, your original DBs won't be changed, but remember that the
conversion is one way. If you decide you want to go back to your old
services, you will lose any changes made while you were running Cygnus,
unless of course your old services have a DB converter for Cygnus.

After this is done, go to the directory you told Cygnus to install to,
and open the cygnus.conf file. Read this file from top to bottom.
There are a number of options that need to be set properly for the
program to function, and others that are enabled/disabled by default
that you may or may not want to use. Each option has a detailed
description on how to configure it above it. Once you have finished
editing your conf, save it, and exit.

If you're feeling especially lazy, you can use the misc/makeconf script to
generate a conf file. However, the disadvantage of this is that makeconf
will only ask you for information required for operation. Any optional
settings (and there's lots of them) will be left at their default
values. It is suggested that you read the conf afterward to find out which
of the wonderful little toys in there are off by default.

If you want to edit the MOTD file, (cygnus.motd) you can do this as
well. The MOTD file is a plain text file displayed when a user requests
it, usually by typing "/motd services.*". If you don't want the default
MOTD but have nothing to put in it, you can safely delete this file, it's
not required for operation.

You should now have Cygnus configured and ready to go. Now make sure
all of the servers on your network have a valid U:Line for Cygnus, and
make sure the server you intend to link it to has valid C, N, and H lines
as well. See below for information on these lines.

You should hopefully already know the syntax of the needed ircd.conf
lines, but if you don't, here they are. These lines assume the
cygnus.conf defaults, which you probably aren't using, so edit these
accordingly.

C:127.0.0.1:linkage:services.example.net::10 
N:127.0.0.1:linkage:services.example.net::10
H:*::services.example.net
U:services.example.net:*:*

The U:Line should be the same on all of your servers. Only the server you
plan to link Cygnus to needs the C/N/H lines.

Once you have your servers set up for Cygnus, you can run the program
by typing:

./cygnus

-----

If you had trouble at any step above, go on irc.habber.net, join
#Services, and state the problem. Please be patient waiting for an answer,
our staff doesn't wait there 24/7 to answer whoever may wander in, but we 
will get to you :)

See the README file for additional information.
