--- ermyth/INSTALL 2007/09/05 11:23:12 1.4 +++ ermyth/INSTALL 2007/09/22 14:27:25 1.5 @@ -1,17 +1,19 @@ -ermyth -- a set of services for IRC networks +Ermyth -- a set of services for IRC networks ===================================================== -This program is free but copyrighted software; see doc/poddoc/license.pod -for details. +Ermyth is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. -Information about Services may be found at http://ermyth.schmorp.de/. +Information about Ermyth may be found at http://ermyth.xinutec.org/. TABLE OF CONTENTS ----------------- 1. Installation 2. Upgrading 3. Setting up IRCd - 4. Starting Services + 4. Starting Ermyth 5. Setting up a crontab entry You should also read the README and FAQ files. @@ -19,13 +21,13 @@ 1. INSTALLATION --------------- -NOTE: if you are using a third party package of Services, most of this section +NOTE: if you are using a third party package of Ermyth, most of this section will not apply. IMPORTANT NOTE: it is not recommended to use and install services as root. Use an unprivileged user account. -Services should compile and run on most POSIX compliant systems. The list of +Ermyth should compile and run on most POSIX compliant systems. The list of platforms that ermyth has been tested on includes: FreeBSD 4.[8,9,10,11] FreeBSD 5.[0,1,2,3,4] @@ -44,11 +46,7 @@ Other BSD-based systems will probably work. Other SysV-based systems *might* work provided they support BSD sockets and POSIX function calls. -Services requires a runtime linker. Systems which do not have a runtime linker -will not be able to run services. However, most systems include a runtime -linker these days. - -IRCd's known to be supported by Services are listed in the example +IRCd's known to be supported by Ermyth are listed in the example config (dist/example.conf). The recommended ones are charybdis, ratbox, inspircd, asuka, beware ircd (bircd), nefarious and undernet-ircu (undernet). @@ -71,7 +69,7 @@ type: $ make -Services will compile. To install, type: +Ermyth will compile. To install, type: $ make install The newly-compiled binary and several supporting files will be copied to the @@ -100,9 +98,9 @@ 3. SETTING UP IRCD ------------------ -Services acts as an IRC server with pseudo-clients on it. To link it to +Ermyth acts as an IRC server with pseudo-clients on it. To link it to your network, you'll need to add some lines in your IRCd's -configuration. Services connects to your IRCd, not the other way around. +configuration. Ermyth connects to your IRCd, not the other way around. It is suggested that you set up your IRCd (IRC operator access, etc) before trying to connect services. Many IRCds do not log much about server @@ -134,7 +132,7 @@ Go into the directory where you installed ermyth (by default, ~/ermyth/). Type ./bin/ermyth to launch services. -Services will report any errors and/or detach into the background. +Ermyth will report any errors and/or detach into the background. If services doesn't link and/or terminates without warning check the log file (var/ermyth.log) to see what happened. If this tells you nothing try