RageIRCd v2.0 (bluemoon): Installation How To
---------------------------------------------

$Id: INSTALL,v 1.16.2.1 2005/02/21 02:32:45 amcwilliam Exp $
(C) 2000-2005 the RageIRCd Development Team, all rights reserved.

Unlike previous versions of RageIRCd, the distribution now uses GNU 
autoconf. This allows greater compatibility across multiple platforms and 
operating systems, and ensures easier portability to others.

1. Please read the documentation provided. Must-reads include all the 
   files within the doc directory (excluding the technical subdirectory), 
   and the RELEASE.NOTES file from the toplevel distribution directory.

2. Place any custom, third-party modules in the modules directory, off the top-
   level RageIRCd v2.0 directory. These must end with a .c suffix.

3. Run the config script. This is an interface to autoconf providing an 
   easy, user-friendly way of setting compile-time options. It will also 
   create a settings file that your answeres are stored in, allowing you 
   to reconfigure your ircd without answering any questions.

   ./config

   For a more detailed overview of the parameters config will accept, you 
   can use ./config with the -h parameter.

4. Advanced users may wish to flick through the include/config.h header 
   file. This contains advanced settings that will greatly affect the 
   functionality of ircd. For most users, this step can be skipped.

5. Compile (make) your ircd. If you are using FreeBSD and encounter weird 
   errors as soon as you initiate the build process, try gmake.

   make

6. Install ircd to the directory you specified in config. Once this step 
   is complete, you need to change to the installation directory. The 
   below syntax uses /usr/local/ircd as an example only.

   make install
   cd /usr/local/ircd

7. Setup your ircd.conf file. Included in the main RageIRCd v2.0 distribution
   is doc/example.conf and doc/reference.conf.txt. The former is an outline of
   basic configuration, which you can use to get your server going. The latter
   is a complete overview of all config variables available in RageIRCd v2.0,
   and should be used as a reference to configure your server properly.
   
   cp doc/example.conf ircd.conf
   more doc/reference.conf.txt
   
   Please remember that even with example.conf, you must set valid masking keys.

Once your server is properly configured, you should be able to boot your ircd
and be chatting! Simply execute the ircd binary within your installation
directory.

See ./ircd -h for help text on controlling your RageIRCd v2.0 server.

End of document.
