]> arthur.barton.de Git - ngircd-web.git/blob - index.html.en
Updated documentation.
[ngircd-web.git] / index.html.en
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN">
2 <html lang="en">
3
4 <head>
5  <title>ngIRCd: Next Generation IRC Daemon</title>
6  <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
7  <meta http-equiv="content-language" content="en">
8  <meta name="author" content="Alexander Barton">
9  <meta name="author-email" content="alex@arthur.ath.cx">
10  <meta name="MSSmartTagsPreventParsing" content="TRUE">
11  <link rel="stylesheet" href="style.css" type="text/css" media="screen">
12  <link rel="author" href="mailto:alex@arthur.ath.cx" title="write an E-Mail to Alex">
13 </head>
14
15 <body>
16
17 <h1>ngIRCd: Next Generation IRC Daemon</h1>
18
19 <p>
20  ngIRCd is a <span title="free as in freedom">free</span> open source
21  daemon for Internet Relay Chat (IRC), developed under the GNU
22  General Public License (<a href="http://www.gnu.org/licenses/gpl.html">GPL</a>).
23
24  It's written from scratch and is not based upon the original IRCd like
25  many others.
26 </p>
27
28 <ol>
29  <li><a href="#status">Status</a>
30  <li><a href="#why">Advantages</a>
31  <li><a href="#platforms">Supported platforms</a>
32  <li><strong><a href="#docu">Documentation</a></strong>
33  <li><a href="#ml">Mailing List</a>
34  <li><a href="#install">Installation</a>
35  <li><strong><a href="#download">Download</a></strong>
36  <ul>
37   <li><a href="#source">Source Code</a></li>
38   <li><a href="#packages">Packages</a></li>
39  </ul>
40  <li><a href="#people">Contact</a>
41  <li><a href="#cvs">CVS Repository</a>
42  <li><a href="#bugs">Bug Tracker</a>
43  <li><a href="#history">History</a>
44 </ol>
45
46 <p>
47  Hint: at <a href="http://freshmeat.net/">freshmeat.net</a>
48  there's an <a href="http://freshmeat.net/projects/ngircd/">entry</a>
49  for the ngIRCd project. You can inform about new releases and get
50  update notifications via E-Mail.
51 </p>
52
53 <p><span class="Hint">
54  BTW: Von dieser Seite gibt es auch eine <a href="index.html.de">deutsche</a>
55  Version.
56 </span></p>
57
58 <p>Mirrors:</p>
59 <ul>
60  <li><a href="http://ngircd.berlios.de/index.html.en">ngircd.berlios.de</a>
61  <li><a href="http://arthur.ath.cx/~alex/ngircd/index.html.en">arthur.ath.cx</a>
62 </ul>
63
64 <h2 id="status">Status</h2>
65
66 <p>
67  Current &quot;stable&quot; version is <strong>0.8.3</strong>.
68 </p>
69 <p class="Security">
70  <strong>Attention:</strong>
71  It is highly recommended to update to at lease ngIRCd release 0.8.3,
72  because older versions of ngIRCd had a remotely exploitable bug which could
73  cause the daemon to crash!<br>
74  You don't need to update from 0.8.2 to 0.8.3 if the daemon isn't compiled
75  to do IDENT lookups (which is the default).
76 </p>
77 <p>
78  This version is used in private IRC networks and is known to run quite
79  stable and flawless although it is not tested in huge IRC networks under
80  heavy load yet. There are still missing features, but the current version
81  should provide everything you need during &quot;normal&quot; IRC sessions.
82 </p>
83 <p>
84  Read more about our private IRC network on these
85  <a href="http://Arthur.Ath.CX/irc/">web pages</a>.
86 </p>
87 <p>
88  I'm glad to receive feedback, bug reports (best choice for this is the
89  <a href="#bugs">Bug-Tracker</a>) and patches. Go on, use the source
90  and keep on hacking!
91 </p>
92 <p>
93  You can reach me (Alex Barton) via E-Mail:
94  <a href="mailto:alex@barton.de">alex@barton.de</a>.
95 </p>
96
97 <h2 id="why">Advantages</h2>
98 <p>
99  Why should you use ngIRCd? Because ...
100 </p>
101 <ul>
102  <li>there are no problems with servers on changing or non-static IP addresses.
103  <li>there is a small and lean configuration file.
104  <li>there is a free, modern and open source C source code.
105  <li>it is still under active development.
106 </ul>
107
108 <h2 id="platforms">Supported platforms</h2>
109 <p>
110  ngIRCd is tested on a regular basis on the following platform
111  (version numbers used in parenthesis). These are the officially
112  supported systems.
113 </p>
114 <ul>
115  <li>AIX (3.2.5, IBM XL C Compiler)
116  <li>A/UX (3.x, original Apple C Compiler or GNU C)
117  <li><a href="http://www.freebsd.org/">FreeBSD</a> (4.5/i386, GNU C)
118  <li><a href="http://www.hp.com/">HP-UX</a> (10.20, GNU C)
119  <li><a href="http://www.hp.com/">HP-UX</a> (9.10/m68k, HP-UX cc)
120  <li>IRIX (6.5, SGI MIPSpro C 7.30)
121  <li><a href="http://www.linux.org/">Linux</a> (2.2.x/i386, 2.4.x/i386 and 2.4.x/hppa, GNU C)
122  <li><a href="http://www.apple.com/macosx/">Mac OS X</a> (10.x, GNU C 2.95.x/3.x)
123  <li><a href="http://www.netbsd.org/">NetBSD</a> (1.5.2/i386 and 1.5.3/m68k, GNU C)
124  <li><a href="http://www.obenbsd.org/">OpenBSD</a> (3.4/i386)
125  <li><a href="http://www.sun.com/">Solaris</a> (2.5.1 and 2.6, GNU C)
126  <li>Windows with <a href="http://sources.redhat.com/cygwin/">Cygwin</a> (GNU C)
127 </ul>
128 <p>
129  As ngIRCd relies on UNIX standards and uses GNU automake and GNU autoconf
130  there are good chances that it also supports UNIX-based operating systems.
131 </p>
132
133 <h2 id="docu">Documentation</h2>
134 <p>
135  There's a bit of documentation in the source code package. One's located
136  in the main directory (e.g. INSTALL, README, NEWS and COPYING) others in
137  subdirectories like <code>&quot;doc&quot;</code> (e.g. CVS.txt, FAQ.txt
138  and sample configuration files like sample-ngircd.conf).
139 </p>
140 <p>Parts of the documentation are available here:</p>
141 <ul>
142  <li><a href="doc/README">README</a>
143  <li><a href="doc/INSTALL">INSTALL</a>
144 </ul>
145 <ul>
146  <li><a href="doc/CVS.txt">CVS.txt</a>
147  <li><a href="doc/ChangeLog">ChangeLog</a>
148  <li><a href="doc/FAQ.txt">FAQ.txt</a>
149  <li><a href="doc/NEWS">NEWS</a>
150  <li><a href="doc/Protocol.txt">Protocol.txt</a>
151  <li><a href="doc/RFC.txt">RFC.txt</a>
152 </ul>
153 <ul>
154  <li><a href="doc/sample-ngircd.conf">sample-ngircd.conf</a>
155 </ul>
156 <ul>
157  <li><a href="doc/README-AUX.txt">README-AUX.txt</a>
158  <li><a href="doc/README-BeOS.txt">README-BeOS.txt</a> (German)
159 </ul>
160
161 <h2 id="ml">Mailing List</h2>
162 <p>
163  There is a mailing list which deals with the &quot;technical&quot;
164  questions concerning ngIRCd: compilation, installation, configuration,
165  and the further development. Updates and CVS-commits are announced
166  here.
167 </p>
168 <p>Please subscribe using the <a href="http://arthur.ath.cx/mailman/listinfo/ngircd-ml">homepage of the list</a>.
169 <p>All postings are archived <a href="http://arthur.ath.cx/pipermail/ngircd-ml/">here</a>.
170
171 <h2 id="install">Installation</h2>
172 <p>
173  ngIRCd's target are systems based on or similar to UNIX. There
174  shouldn't be any problem on a fairly modern UNIX that's supported by
175  GNU automake and GNU autoconf. If you run into compile problems
176  perhaps you should give GNU C a try (version 2.95 or newer).
177 </p>
178 <p>
179  Typical usage is:
180 </p>
181 <blockquote><p><code>
182  tar xzf ngircd-&lt;version&gt;.tar.gz<br>
183  cd ngircd-&lt;version&gt;<br>
184  ./configure<br>
185  make
186 </code></p></blockquote>
187 <p>
188  Now there's the binary executable server file in <code>src/ngircd</code>
189  (&quot;<code>ngircd</code>&quot; in most cases).
190 </p>
191 <blockquote><p><code>
192  make install
193 </code></p></blockquote>
194 <p>
195  The binary executable is now installed in <code>/usr/local/sbin</code>.
196 </p>
197 <p>
198  The server looks for the configuration file <code>ngircd.conf</code> in
199  <code>/usr/local/etc</code>. A sample configuration file can be found in
200  <code>doc</code>.
201 </p>
202 <p>
203  Further help on installation and configuration can be found in
204  <code><a href="doc/INSTALL">INSTALL</a></code>.
205 </p>
206
207 <h2 id="download">Download</h2>
208 <h3 id="source">Source Code</h3>
209 <dl>
210  <dt><strong>ngIRCd 0.8.3</strong> (2005-02-03):</dt>
211  <dd>
212         <p>Server: <em>download.berlios.de</em> (<a href="ftp://ftp.berlios.de/pub/ngircd/">ftp</a>)</p>
213         <ul>
214                 <li>ngircd-0.8.3.tar.gz:
215                     <a href="http://download.berlios.de/ngircd/ngircd-0.8.3.tar.gz">http</a>,
216                     <a href="ftp://ftp.berlios.de/pub/ngircd/ngircd-0.8.3.tar.gz">ftp</a>
217         </ul>
218         <p>Server: <em>arthur.ath.cx</em> (<a href="ftp://Arthur.Ath.CX/pub/Users/alex/ngircd/">ftp</a>)</p>
219         <ul>
220                 <li>ngircd-0.8.3.tar.gz:
221                     <a href="ftp://Arthur.Ath.CX/pub/Users/alex/ngircd/ngircd-0.8.3.tar.gz">ftp</a>.
222         </ul>
223  </dd>
224 </dl>
225 <p>
226  In addition, all previous versions, GnuPG signatures, as well as nightly tar-balls
227  (generated from the CVS HEAD sources) are also available. Look here:
228  <a href="ftp://arthur.ath.cx/pub/Users/alex/ngircd/">ftp</a>.
229 </p>
230 <h3 id="packages">Packages</h3>
231 <p>
232  If you are using one of the following distributions, you can use their packages:
233 </p>
234 <ul>
235  <li>
236   <a href="http://www.freebsd.org/">FreeBSD</a>:
237   <a href="http://www.freebsd.org/cgi/ports.cgi?query=ngircd&amp;stype=all">Port</a>
238  </li>
239  <li>
240   <a href="http://www.gentoo.org/">Gentoo Linux</a>:
241   <a href="http://packages.gentoo.org/packages/?category=net-irc;name=ngircd">ebuild</a>
242  </li>
243 </ul>
244 <p>
245  Inofficial packages:
246 </p>
247 <ul>
248  <li>
249   <a href="http://www.debian.org/">Debian Linux</a>:
250   <a href="ftp://arthur.ath.cx/debian/dists/ab/main/">deb</a>
251   (Autor: Alex Barton)
252  </li>
253 </ul>
254
255 <h2 id="people">Contact</h2>
256 <p>
257  Idea and most parts of the current code:
258  Alexander Barton (<a href="mailto:alex@barton.de">alex@barton.de</a>).
259 </p>
260 <p>
261  Thanks to
262  Ilja Osthoff (<a href="mailto:ilja@glide.ath.cx">ilja@glide.ath.cx</a>)
263  for translating parts of the documentation into english and
264  G&ouml;tz Hoffart (<a href="mailto:goetz@hoffart.de">goetz@hoffart.de</a>)
265  for translating the web page.
266 </p>
267 <p>
268  If you find bugs or have some ideas for enhancements, please file them
269  into the <a href="#bugs">bug tracker</a>. In addition, there is a
270  <a href="#ml">mailing list</a> for discussions concerning the ngIRCd.
271 </p>
272 <p>BTW: Patches are welcome ;-)</p>
273
274 <h2 id="cvs">CVS Repository</h2>
275 <p>
276  The source and all files belonging to ngIRCd are managed using
277  <a hreflang="en" href="http://www.cvshome.org/"><abbr title="Concurrent Versions
278  System">CVS</abbr></a>. Anonymous access is available, read:
279  <a href="doc/CVS.txt">CVS.txt</a>.
280 </p>
281 <p>
282  The repository is online available through HTTP:
283  <a href="http://Arthur.Ath.CX/cgi-bin/viewcvs.cgi/ngircd/">ngIRCd CVS Reposidtory</a>.
284 </p>
285
286 <h2 id="bugs">Bug Tracker</h2>
287 <p>
288  In order to keep track of feature requests and found bugs there's a
289  Bug Tracking system: <a href="http://arthur.ath.cx/bugzilla/ngircd/">Bugzilla</a>
290 </p>
291 <p>
292  In case you found a bug please check
293  <a href="http://arthur.ath.cx/bugzilla/ngircd/enter_bug.cgi">Bug-Report</a>
294  and describe the circumstances. Thank you!
295 </p>
296 <p>
297  In addition you can <a href="http://arthur.ath.cx/bugzilla/ngircd/query.cgi">inform</a>
298  about known and perhaps fixed bugs.
299 </p>
300
301 <h2 id="history">History</h2>
302 <p>
303  Please read the files
304  <a href="doc/NEWS">NEWS</a> and
305  <a href="doc/ChangeLog">ChangeLog</a>
306  for detailed information.
307 </p>
308
309 <!-- Footer -->
310 <hr style="margin-top: 0.75em;">
311 <p style="text-align: center">
312  Thanks to:<br>
313  <a href="http://developer.berlios.de"><img src="http://developer.berlios.de/sflogo.php?group_id=546&amp;type=1" width="124" height="32" alt="BerliOS Logo" style="border: 0"></a>
314 </p>
315 <hr>
316 <p>
317  <img src="valid-html401.gif" style="float: right;" alt="Valid HTML 4.01!" height="31" width="88">
318  <small>
319   Version: $Id$
320   <br>
321   <a hreflang="en" href="http://validator.w3.org/check?uri=http%3A%2F%2Farthur.ath.cx%2F%7Ealex%2Fngircd%2Findex.html.en">Validate</a> page.<br>
322   Contact: Alexander Barton, E-Mail: <a href="mailto:alex@arthur.ath.cx">alex@arthur.ath.cx</a>.<br>
323   Thanks to <a href="mailto:goetz@hoffart.de">G&ouml;tz Hoffart</a> for cleaning up this page and the english translation!
324  </small>
325 </p>
326
327 </body>
328 </html>