INSTALL

   1               NeonServ Installation Instructions
   2
   3 Introduction:
   4 ----------
   5 If you encounter any problems compiling/running NeonServ, please make
   6 sure you have followed the directions in this file correctly and that
   7 all of the requirements listed below are met.
   8
   9 If the problem persists, report it to one (or all) of the coders
  10 listed in the AUTHORS file. Please try to include ALL relevant
  11 information about the error/bug, including anything out of the
  12 ordinary reported from make and the appropriate entries from the log
  13 files.
  14
  15 Quick Install:
  16 ----------
  17 $ ./autogen.sh
  18 $ ./configure
  19 $ make
  20 $ ${EDITOR} neonserv.conf
  21     NOTE: You may want to copy neonserv.example.conf to neonserv.conf and
  22     edit that.
  23 $ php language.php    (optional)
  24 $ ./neonserv
  25
  26 Compiling:
  27 ----------
  28   1) Enter the root directory of the NeonServ tree.  If installation is
  29      done from outside of it, it may cause problems during compile, or
  30      during runtime.
  31
  32   2) If you've cloned a development snapshot of NeonServ from git.pk910.de
  33      you need to generate the configure and Makefile files. For that you
  34      simply need to run the autogen.sh script.
  35      (chmood it to be executeable if needed)
  36
  37   3) Run the configure script (sh configure), it will verify that your
  38      system will have the resources needed for NeonServ to compile. If
  39      you would like to change the path where NeonServ will be installed
  40      to, execute configure with the --prefix=/path option.  The default
  41      path is ~/neonserv/.
  42
  43
  44   4) You may optionally edit config.h in case the configure script made a
  45      mistake.
  46
  47   5) Execute the "make" command to begin compiling.  If you encounter any
  48      uncorrectable errors/warnings, please scroll up to the introduction
  49      section and follow the instructions.
  50
  51   6) You may now either type "make install" to install it to your
  52      installation path, or work from your build directory, either is fine.
  53
  54   7) Copy neonserv.example.conf to neonserv.conf and edit the mysql information.
  55
  56  10) Once you have NeonServ for the first time, it will create the neccesary
  57      tables in your database. Take a look into `bots` to edit Bot settings like
  58      nick and server (You need to restart the bot to apply these settings).
  59      You also need to add youself into the `users` table with 1000 access.
  60
  61  11) To get the actual language pack (including help strings) run the included
  62      language.php  (and rehash the bot's language cache with `reloadlang <tag>`)
  63
  64  12) You can now register a channel via the bots query ;)
  65
  66 End of file, INSTALL.
  67
  68 -pk910 (neonserv@pk910.de)