From 679b8f0b7689c434f5369d08e15f042db24c2d70 Mon Sep 17 00:00:00 2001 From: Remco Rijnders Date: Wed, 17 Oct 2012 08:14:03 +0200 Subject: [PATCH] INSTALL text was several years out of date Brought it into 2012 :-) --- INSTALL | 140 +++++++++++++++++++++++--------------------------------- 1 file changed, 58 insertions(+), 82 deletions(-) diff --git a/INSTALL b/INSTALL index 245fbff..6b6f9c1 100644 --- a/INSTALL +++ b/INSTALL @@ -1,53 +1,36 @@ -Installation Procedures for the StarChat IRC Server: +Installation Procedures for the Serenity IRC Server: ======================================================================= by Alexei Kosut (Lefler) with changes for dal4.3.6 by Mikko Hänninen (Wizzu) for dal4.3.6 with changes for dal4.4.11 by Cabal95 (cabal95@dal.net) with changes for Star4.10.Spire by GZ (gz@starchat.net) +with changes for Serene5.28 by Remmy (remmy@serenity-irc.net) ======================================================================= -This document describes how to install ircd, the unix daemon that acts as -an IRC server. Specifically, for the StarChat IRC Network, though some -information may be applicable to other networks as well. +This document describes how to install serene-ircd, the unix daemon that acts as +an IRC server. The information is specifically for the Serenity-IRC Network, +though some information may be applicable to other networks as well. -For more information on StarChat or this server, please see our WWW page at -, or contact us at sc@starchat.net. +For more information on Serenity-IRC or this server, please see our webpage at +, or contact us at coding@serene-ircd.net . -For help with this ircd, try joining #ircd on StarChat. There you will find a friendly -staff who can help you with most common problems affecting the ircd. If they can't help, -they'll probably be able to find someone who will. :-) +For help with this ircd you can join #coding on Serenity-IRC. There you will +find a friendly staff who can help you with most common problems affecting the +ircd. If they can't help, they'll probably be able to find someone who will. +:-) -The StarChat server is available from ftp://utopia.starchat.net/pub/, along with the -latest copy of this document. +The Serene IRC server is available from our git repository which can be browsed +from http://git.serene-ircd.net/ , or see http://www.serene-ircd.net/ for +instructions on cloning the repository to your own system. ======================================================================= -This version of the StarChat IRC Server is known to compile on the following -platforms, and with the following compilers. If you wish to add to this -list, send the relevant information to us. +This version of the Serene IRC Server is known to compile on recent Linux +distributions and should also work on FreeBSD. Support for obsolete platforms +has been removed over the years. Support to compile this ircd on MS Windows is +also no longer included in this release. -OS and Version Compiler and Version Comments -------------------- ------------------------ ------------------------------- -NetBSD 1.2B gcc 2.7.2 - -FreeBSD 2.1.0 gcc 2.6.3 Do NOT use crypt at all... - -SunOS 4.1.4 gcc 2.7-96q1 (Cygnus) - -Solaris 2.4 gcc 2.7-96q1 (Cygnus) (SunOS 5.4) - -Solaris 2.5 SunWorks Pro C (SunOS 5.5.1) - cc: SC4.0 18 Oct 1995 C 4.0 - -Digital Unix 3.2 gcc 2.7-96q3 (Cygnus) - -Linux 2.0.24 gcc 2.7.2.1 should now also compile - under Red Hat 5.0 - -HPUX 9.01 gcc 2.6.3 - -HPUX 10.01 gcc 2.7-96q3 (Cygnus) ======================================================================= Unpacking the Distribution @@ -55,14 +38,17 @@ Unpacking the Distribution If you are reading this, you have most likely already done this, but to recap: -The StarChat server -comes tarred and gzipped. To uncompress it and expand it, use the -following command at the Unix prompt: +The Serene IRC server can be cloned from git, or the latest version can be +downloaded from http://www.serenity-irc.net/assets/Serene-latest.tar.gz if you +don't use git. -tar -xzf Star4.10.tar.gz +If you use the tarball from our website, you need to uncompress it and expand +it first, using the following command at the prompt: -This will create a new directory called Star4.10, and unpack the source -into it. +tar -xzf Serene-latest.tar.gz + +This will create a new directory called Serene5.xx (where xx is the version +number of the latest release), and unpack the source into it. ======================================================================= Editing the Configuration Files @@ -70,34 +56,30 @@ Editing the Configuration Files In previous versions of the source code many files had to be edited to make things right for any given server. -In this version you DO NOT NEED TO EDIT THE Makefile OR ANY FILES -IN include! That is, unless you set some strange options. If you -find the need to edit include/config.h, for example, mail us and -tell us why ; Config can be made smarter, and that will make it so -you won't have to edit anything for the next version +In this version you DO NOT NEED TO EDIT THE Makefile OR ANY FILES IN include! +That is, unless you set some strange options. If you find the need to edit +include/config.h, for example, mail us and tell us why; Config can be made +smarter, and that will make it so you won't have to edit anything for the next +version ======================================================================= Compiling Your Server -Windows users: You must compile the Config program first. To do this -run the following command: $CC src\Config.c -where $CC is the name of your compiler. for MSVC users that is 'cl' - To build the server, simply run - % ./Config -to start the configuraton program. This program looks at your system + $ ./Config +to start the configuration program. This program looks at your system and generate the include/setup.h, include/options.h, and Options files. You will be asked some questions. Usually the default answers are the best ones and most correct. To accept the default, just hit RETURN. -Next, type 'make'. This will compile your server. Depending on your system, -this may be a good time for a caffeine break. (MSVC users run 'nmake') +Next, type 'make'. This will compile your server which should only take a short +time to complete. -Hopefully, the server will compile without incident. If it does not, and -you are not able to determine the error, please email coding@starchat.net -and hopefully someone will be able to help you with the problem. If you -do need to fix something, mail there with a patch. Alternatively, try #ircd -on StarChat. +Hopefully, the server will compile without incident. If it does not, and you +are not able to determine the error, please email coding@serene-ircd.net and +hopefully someone will be able to help you with the problem. If you do need to +fix something, mail there with a patch. Alternatively, try #coding on +Serenity-IRC. BE CERTAIN TO INCLUDE OPERATING SYSTEM INFORMATION (uname -a) AND COMPILER VERSION (gcc -v, for instance) IN ALL BUG REPORTS. @@ -105,45 +87,39 @@ VERSION (gcc -v, for instance) IN ALL BUG REPORTS. Common problems =============== -If, when you try to compile, something like the following halts make: -res.o: In function `proc_answer': -/home/GZ/Star4.10/src/res.c:617: undefined reference to `dn_expand' -/home/GZ/Star4.10/src/res.c:622: undefined reference to `_getshort' -/home/GZ/Star4.10/src/res.c:624: undefined reference to `_getshort' +If you have chosen to include server compression, you need to ensure you have +the zlib-devel library installed on your system or the compilation will fail. -you need to include a separate library. Rerun ./Config and in the space -where it asks you what additional libraries you would like to include, -type "-lresolv". If a similar problem occurs referring to 'crypt', -include the "-lcrypt" library aswell. ======================================================================= Installing the Files -'make install' does not work in this release -- it doesn't do anything -except a compile if that is needed. +'make install' copies the generated binary to the location you indicated during +the configuration process (assuming that the target directory exists and is +writable by you). -The only files you need are the binary from src/ircd and and an ircd.conf +The only files you'll really need are the binary from src/ircd and an ircd.conf (see below for copying doc/example.conf as your initial ircd.conf). You -probably will want to create a MOTD file too, as well as place the man -pages from the doc directory to appropriate place in your system. +probably will want to create a MOTD file too. ======================================================================= Configuring Your Server -The previous step places a file named 'example.conf' into your irc -directory you specified to Config. +If you don't have an existing ircd.conf yet, you can start with using our +'example.conf' and copy it into your irc directory which you specified to +Config. To create an IRC configuration file, type: - cp example.conf ircd.conf + cp doc/example.conf /path/to/ircd.conf -Now edit this file to reflect your server. The file is mainly -self-explanatory. Note that if you plan to use your server on StarChat, -make sure that you have the following line: +Now edit this file to reflect your server. The file is mainly self-explanatory. +Note that if you plan to use your server on Serenity-IRC, make sure that you +have the following line: -U:services.starchat.net:*:* +U:Services.Serenity-IRC.Net:*:* -If you need help configuring your file, please join StarChat, go to channel -#ircd, and ask. +If you need help configuring your file, please join Serenity-IRC, go to channel +#coding, and ask. ======================================================================= -- 2.30.2