X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=INSTALL;h=60e7b5ebff45488365786aa582ce93f9215070b3;hp=60fde8a017fc36f5c869dc6f7cbd6e312f93b319;hb=0e4e22a7a671d1e8efbc44bffd80062191f75c38;hpb=be54db83c96e76a20097bb10e1d0b8493828feff diff --git a/INSTALL b/INSTALL index 60fde8a0..60e7b5eb 100644 --- a/INSTALL +++ b/INSTALL @@ -1,148 +1,246 @@ ngIRCd - Next Generation IRC Server - (c)2001,2002 by Alexander Barton, + (c)2001-2007 Alexander Barton, alex@barton.de, http://www.barton.de/ - ngIRCd ist freie Software und steht unter - der GNU General Public License. + ngIRCd is free software and published under the + terms of the GNU General Public License. + + -- INSTALL -- - -- INSTALL / Installation -- - Ilja Osthoff, +I. Upgrade Information +~~~~~~~~~~~~~~~~~~~~~~ - +-----------------------------------------------------------------------+ - | Please note: English translations of some of the german documentation | - | files can be found in the directory "doc/en" -- please have a look! | - +-----------------------------------------------------------------------+ +Differences to version 0.9.x +- The option of the configure script to enable support for Zeroconf/Bonjour/ + Rendezvous/WhateverItIsNamedToday has been renamed: + --with-rendezvous -> --with-zeroconf -I. Standard-Installation -~~~~~~~~~~~~~~~~~~~~~~~~ +Differences to version 0.8.x + +- The maximum length of passwords has been raised to 20 characters (instead + of 8 characters). If your passwords are longer than 8 characters then they + are cut at an other position now. + +Differences to version 0.6.x + +- Some options of the configure script have been renamed: + --disable-syslog -> --without-syslog + --disable-zlib -> --without-zlib + Please call "./configure --help" to review the full list of options! + +Differences to version 0.5.x + +- Starting with version 0.6.0, other servers are identified using asynchronous + passwords: therefore the variable "Password" in [Server]-sections has been + replaced by "MyPassword" and "PeerPassword". + +- New configuration variables, section [Global]: MaxConnections, MaxJoins + (see example configuration file "doc/sample-ngircd.conf"!). + + +II. Standard Installation +~~~~~~~~~~~~~~~~~~~~~~~~~ + +ngIRCd is developed for UNIX-based systems, which means that the installation +on modern UNIX-like systems that are supported by GNU autoconf and GNU +automake ("configure") should be no problem. + +The normal installation procedure after getting (and expanding) the source +files (using a distribution archive or GIT) is as following: + + 1) ./autogen.sh [only necessary when using GIT] + 2) ./configure + 3) make + 4) make install + +(Please see details below!) + +Now the newly compiled executable "ngircd" is installed in its standard +location, /usr/local/sbin/. + +The next step is to configure and afterwards starting the daemon. Please +have a look at the ngircd(8) and ngircd.conf(5) manual pages for details +and all possible options. + +If no previous version of the configuration file exists (the standard name +is /usr/local/etc/ngircd.conf), a sample configuration file containing all +possible options will be installed there. You'll find its template in the +doc/ directory: sample-ngircd.conf. -ngIRCd ist fuer UNIXoide-Systeme konzipiert worden, das bedeutet, dass die -Installation auf einem modernen UNIX-aehnlichen System kein Problem dar- -stellen sollte. Das System muss nur von GNU automake und GNU autoconf -("configure") unterstuetzt werden. -Die Standard-Installation sieht so aus: +1): "autogen.sh" - 1) tar xzf ngircd-.tar.gz - 2) cd ngircd- - 3) ./autogen.sh [nur erforderlich, wenn ueber CVS bezogen] - 4) ./configure - 5) make - 6) make install +The first step, autogen.sh, is only necessary if the configure-script isn't +already generated. This never happens in official ("stable") releases in +tar.gz-archives, but when using GIT. +This step is therefore only interesting for developers. -zu 3): "autogen.sh" +autogen.sh produces the Makefile.in's, which are necessary for the configure +script itself, and some more files for make. To run autogen.sh you'll need +GNU autoconf and GNU automake (use recent versions! autoconf 2.53 and +automake 1.6.1 are known to work). -Der erste Schritt, autogen.sh, ist nur notwendig, wenn das configure-Script -noch nicht vorhanden ist. Dies ist nie bei offiziellen ("stabilen") Versionen -in tar.gz-Archiven der Fall, jedoch nie, wenn der Source-Code ueber CVS -bezogen wurde. +Again: "end users" do not need this step! -Dieser Absatz ist also eigentlich ausschliesslich fuer Entwickler interessant. -autogen.sh erzeugt die fuer das configure-Script notwendigen Makefile.in's -sowie das configure-Script selber und weitere fuer den make-Lauf erforderliche -Dateien. Dazu wird sowohl GNU automake als auch GNU autoconf (in aktuellen -Versionen!) benoetigt. +2): "./configure" -(nochmal: "Endanwender" mussen diesen Schritt i.d.R. nicht ausfuehren!) +The configure-script is used to detect local system dependencies. +In the perfect case, configure should recognise all needed libraries, header +files and so on. If this shouldn't work, "./configure --help" shows all +possible options. -zu 4): "./configure" +In addition, you can pass some command line options to "configure" to enable +and/or disable some features of ngIRCd. All these options are shown using +"./configure --help", too. -Mit dem configure-Script wird ngIRCd, wie GNU Software meistens, an das -lokale System angepasst und die erforderlichen Makefile's erzeugt. +Compiling a static binary will avoid you the hassle of feeding a chroot dir +(if you want use the chroot feature). Just do something like: + CFLAGS=-static ./configure [--your-options ...] +Then you can use a void directory as ChrootDir (like OpenSSH's /var/empty). -Im Optimalfall sollte configure alle benoetigten Libraries, Header etc. selber -erkennen und entsprechend reagieren. Sollte dies einmal nicht der Fall sein, -so zeigt "./configure --help" moegliche Optionen. +3): "make" -zu 5): "make" +The make command uses the Makefiles produced by configure and compiles the +ngIRCd daemon. -Der make-Befehl bearbeitet die vom configure-Script erzeugten Makefile's und -uebersetzt den ngIRCd. +4): "make install" -zu 6): "make install" +Use "make install" to install the server and a sample configuration file on +the local system. Normally, root privileges are necessary to complete this +step. If there is already an older configuration file present, it won't be +overwritten. -Mit "make install" wird der Server und ggf. eine Beispiels-Konfiguration -im System installiert; hierzu sind in der Regel root-Rechte erforderlich. -Eine bereits vorhandene Konfigurationsdatei wird nie ueberschrieben. +This files will be installed by default: -Folgende Dateien werden installiert: +- /usr/local/sbin/ngircd: executable server +- /usr/local/etc/ngircd.conf: sample configuration (if not already present) +- /usr/local/share/doc/ngircd/: documentation -- /usr/local/sbin/ngircd: ausfuehrbarer Server -- /usr/local/etc/ngircd.conf: Beispiel-Konfiguration, wenn nicht vorhanden +III. Additional features +~~~~~~~~~~~~~~~~~~~~~~~~ + +The following optional features can be compiled into the daemon by passing +options to the "configure" script. Most options can handle a argument +which will be used to search for the required libraries and header files in +the given paths ("/lib/...", "/include/...") in addition to the +standard locations. + +* Syslog Logging (autodetected by default): + --with-syslog[=] / --without-syslog + + Enable (disable) support for logging to "syslog", which should be + available on most modern UNIX-like operating systems by default. + +* ZLib Compression (autodetected by default): + --with-zlib[=] / --without-zlib + + Enable (disable) support for compressed server-server links. + The Z compression library ("libz") is required for this option. + +* IO Backend (autodetected by default): + --with-select[=] / --without-select + --with-poll[=] / --without-poll + --with-devpoll[=] / --without-devpoll + --with-epoll[=] / --without-epoll + --with-kqueue[=] / --without-kqueue + + ngIRCd can use different IO "backends": the "old school" select() and poll() + API which should be supported by most UNIX-like operating systems, or the + more efficient and flexible epoll() (Linux >=2.6), kqueue() (BSD) and + /dev/poll APIs. + By default the IO backend is autodetected, but you can use "--without-xxx" + to disable a more enhanced API. + When using the epoll() API, support for select() is compiled in as well by + default to enable the binary to run on older Linux kernels (<2.6), too. + +* IDENT-Support: + --with-ident[=] + + Include support for IDENT ("AUTH") lookups. The "ident" library is + required for this option. -III. Nuetzliche make-Targets -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +* ZeroConf Support: + --with-zeroconf[=] -Die vom configure-Script erzeugten Makefile's enthalten immer die folgenden -nuetzlichen Targets: + Compile ngIRCd with support for ZeroConf multicast DNS service registration. + Either the Apple ZeroConf implementation (e. g. Mac OS X) or the Howl + library is required. Which one is available is autodetected. - - clean: alle Erzeugnisse des Compilers/Linkers loeschen. - Naechster Schritt: -> make +* TCP-Wrappers: + --with-tcp-wrappers[=] - - distclean: zusaetzliche alle Makefile's loeschen. - Naechster Schritt: -> ./configure + Include support for Wietse Venemas "TCP Wrappers" to limit client access + to the daemon, for example by using "/etc/hosts.{allow|deny}". + The "libwrap" is required for this option. - - maintainer-clean: alle automat. erzeugten Dateien loeschen. - Naechster Schritt: -> ./autogen.sh +IV. Useful make-targets +~~~~~~~~~~~~~~~~~~~~~~~ +The Makefile produced by the configure-script contains always these useful +targets: -IV. Konfigurationsdatei ngircd.conf -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + - clean: delete every product from the compiler/linker + next step: -> make -In der Konfigurationsdatei werden Kommentare durch "#" oder durch ";" -eingeleitet. Dieses dient nur der besseren Lesbarkeit. + - distclean: the above plus erase all generated Makefiles + next step: -> ./configure -Die Datei ist in drei Abschnitte unterteilt: [Global], [Operator] und -[Server]. Im [Global]-Teil werden die grundlegenden Einstellungen vor- -genommen, z.B. der Server-Name und die Ports, auf denen er Verbindungen -annehmen soll. In [Operator]-Abschnitten werden Server-Operatoren fest- -gelegt und unter [Server] werden die Einstellungen fuer die Verbindung -mit anderen Servern konfiguriert. + - maintainer-clean: erase all automatic generated files + next step: -> ./autogen.sh -Die Bedeutung der einzelnen Variablen ist in der Beispiel-Konfiguration -"doc/sample-ngircd.conf" erklaert, die bei "make install" auch als -"ngircd.conf" in /usr/local/etc installiert wird, wenn dort noch keine -Konfigurationsdatei vorhanden ist. +V. Sample configuration file ngircd.conf +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -V. Kommandozeilen-Optionen -~~~~~~~~~~~~~~~~~~~~~~~~~~ +In the sample configuration file, there are comments beginning with "#" OR +";" -- this is only for the better understanding of the file. -Folgende Parameter koennen dem ngIRCd u.a. uebergeben werden: +The file is separated in four blocks: [Global], [Operator], [Server], and +[Channel]. + +In the [Global] section, there is the main configuration like the server +name and the ports, on which the server should be listening. IRC operators +of this server are defined in [Operator] blocks. [Server] is the section +where server links are configured. And [Channel] blocks are used to +configure pre-defined ("persistent") IRC channels. + +The meaning of the variables in the configuration file is explained in the +"doc/sample-ngircd.conf", which is used as sample configuration file in +/usr/local/etc after running "make install" (if you don't already have one) +and in the "ngircd.conf" manual page. + + +VI. Command line options +~~~~~~~~~~~~~~~~~~~~~~~~ + +These parameters could be passed to the ngIRCd: -f, --config - Der Daemon wird angewiesen, statt der Standard-Konfigurationsdatei - /usr/local/etc/ngircd.conf die Datei einzulesen. + The daemon uses the file as configuration file rather than + the standard configuration /usr/local/etc/ngircd.conf. -n, --nodaemon - ngIRCd soll im Fordergrund laufen; alle Meldungen werden zusaetzlich - zum Syslog auch auf der Konsole ausgegeben. + ngIRCd should be running as a foreground process. -p, --passive - Verbindungen zu anderen Servern (wie in der Konfigurationsdatei in - [Server]-Abschnitten definiert) werden nicht automatisch hergestellt. - ---configtest - Die Konfigurationsdatei wird eingelesen, ueberprueft und so aus- - gegeben, wie sie vom ngIRCd interpretiert wurde. Danach beendet - sich der Server wieder. - -Mit dem Parameter "--help" werden alle unterstuetzten Parameter angezeigt, -mit "--version" die Versionsnummer. Bei beiden Parametern beendet sich der -Server nach der Ausgabe wieder. + Server-links won't be automatically established. +-t, --configtest + Reads, validates and dumps the configuration file as interpreted + by the server. Then exits. --- -$Id: INSTALL,v 1.6 2002/05/08 15:44:43 alex Exp $ +Use "--help" to see a short help text describing all available parameters +the server understands, with "--version" the ngIRCd shows its version +number. In both cases the server exits after the output.