INSTALL

   1 INSTALL file        by Run <carlo@runaway.xs4all.nl>
   2             Updated by Isomer <isomer@coders.net>
   3             Updated for u2.10.11 by Kev <klmitch@mit.edu>
   4
   5 This is the UnderNet IRC daemon.
   6
   7 The installation of the IRC daemon (ircd) exists of the following steps:
   8
   9 1) Retrieve the package.
  10 2) cd into the base directory.
  11 3) "./configure"
  12 4) "make"
  13 5) "make install"
  14
  15 1) Retrieve the package.
  16 ========================
  17
  18 The recommended way to get the ircu package now is to use CVS.  CVS makes
  19 upgrades a lot less painful and lets you get the latest package.
  20
  21 1.1) The first thing you need to do is "authenticate" yourself against the
  22 server.
  23
  24 This is done with:
  25
  26 cvs -d :pserver:anoncvs@coder-com.undernet.org:/home/coder-com/cvs login
  27
  28 (we recommend that you cut and paste the above line to use it :)
  29 When it prompts you for a password enter "anoncvs".
  30
  31 1.2) The module you will check out is ircu2.10.  There are three branches
  32 you can check out.
  33
  34 stable - This branch is always the recommended version for use on the
  35        Undernet.  To check out the stable tree, add "-r u2_10_11" to
  36        the CVS command line.
  37
  38 beta - This branch is undergoing testing before being promoted to the
  39        stable branch.  It may be buggy.  Use on the Undernet's production
  40        network is prohibited, except for certain authorized servers.  The
  41        "-r" flag you need to check this branch out is documented on the
  42        Coder Committee's web site, http://coder-com.undernet.org.
  43
  44 alpha - This is the development branch.  It is not guaranteed to even
  45        compile, and should be considered HIGHLY unstable.  It is NOT
  46        intended for production use.  If you wish to play with the server,
  47        you may wish to investigate the test network.  To check this branch
  48        out, use no "-r" flags.
  49
  50
  51 to check out the tree, type:
  52
  53 cvs -d :pserver:anoncvs@coder-com.undernet.org:/home/coder-com/cvs checkout
  54    -P ircu2.10
  55
  56 The above two lines shouldn't have an enter between them.  If you want to
  57 use another branch, place the appropriate "-r" flag after the "checkout"
  58 command.  This will create a directory ircu2.10, and put all the files in
  59 there.
  60
  61 To get the latest version, from within the tree type "cvs update -dP".
  62
  63 For more information see the coder-com website at
  64 http://coder-com.undernet.org/
  65
  66 The old (tried and true) method that works even when the website isn't being
  67 DoS'd (sigh) is included below.  Using the method below means you can't
  68 just type 'cvs update -dP' to get the latest version.
  69
  70  The name of the package is something like `ircu2.x.y.z.tgz', where
  71  "x.y.z" is the current release (at the time of writing we have
  72  ircu2.10.00.beta3.tgz).
  73
  74  You need `gzip', the GNU unzip command, to uncompress this package.
  75  You can download this from every GNU ftp site for almost any Operating system.
  76
  77  If you have GNU tar, type:
  78
  79  tar xzf ircu2.x.y.z.tgz
  80
  81  where "ircu2.x.y.z.tgz" is the name of the package.
  82
  83  If your tar doesn't support the 'z' flag, you can type alternatively:
  84
  85  gzip -dc ircu2.x.y.z.tgz | tar xf -
  86
  87  Both methods result in a directory "ircu2.x.y.z" in your current directory.
  88
  89 2) cd into the base directory
  90 =============================
  91
  92 Make this directory your current directory by typing:
  93
  94 cd ircu2.x.y.z
  95
  96 or ircu2.10 if you used cvs.
  97
  98 where "ircu2.x.y.z" is the name of the unpacked directory.
  99
 100 3) "./configure"
 101 ================
 102
 103 This will generate "config.h", your operating system-dependent
 104 configuration.
 105
 106 If this produces a "Permission Denied" error message, then try typing
 107 "chmod a+x ./configure" first to give yourself permission to run the file.
 108
 109 For information on configure command line options, type "./configure --help".
 110
 111 4) "make"
 112 =========
 113
 114 Type:
 115
 116 make
 117
 118 in the base directory.  It should compile without errors or warnings.
 119 Please mail any problem to the maintainer, but only AFTER you made sure
 120 you did everything the right way.  If you want your operating system
 121 to be supported in future releases, you best make a patch that
 122 actually fixes the problem.
 123
 124 5) "make install"
 125 =================
 126
 127 This should install the ircd and the man page. Please recheck the
 128 permissions of the binary.
 129
 130 Of course, you need a syntactically correct ircd.conf in DPATH.  See the
 131 docs for some info on this.  Also create an ircd.motd with the text of
 132 your MOTD.  And finally create a remote.motd with three lines of text
 133 as the remote MOTD.  Again, all of these files should be readable by the
 134 ircd, and the logfiles should be writeable.
 135
 136
 137 In case of problems
 138 ===================
 139
 140 If you have problems configuring the server you might consider installing
 141 GNU make in your PATH.  In some cases a brain-dead /bin/sh is causing the
 142 problem, in which case I suggest to install "bash" and use that (as sh ->
 143 bash).  Finally, any other compile problem should be solved when you install
 144 gcc.
 145
 146 If you have problems with starting the ircd, run "./configure" again
 147 and give it the "--enable-debug" command line option.  Recompile the ircd,
 148 and run it by hand as:
 149
 150 ircd -t -x9
 151
 152 This will write debug output to your screen, probably showing why it
 153 doesn't start.
 154
 155 DO NOT USE A SERVER WITH DEBUGGING ENABLED ON A PRODUCTION NETWORK.  Doing
 156 so is a severe privacy risk.
 157
 158 If things still don't work, try emailing coder-com@undernet.org