]> arthur.barton.de Git - ngircd-web.git/blob - index.html.en
Updated documentation for GIT.
[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@barton.de">
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@barton.de" 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="#git">GIT 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://ngircd.barton.de/index.html.en">ngircd.barton.de</a>
62 </ul>
63
64 <h2 id="status">Status</h2>
65
66 <p>
67  Current &quot;stable&quot; version is <strong>0.11.1</strong>.
68  Version <strong>0.12.0-pre2</strong> is available for testing.
69  Please see <a href="#download">below</a> for download locations.
70 </p>
71 <p class="Security">
72  <strong>Attention:</strong>
73  ngIRCd-versions previous to 0.10.4 comprise an error which can be used
74  (also by remote) to crash the daemon. All installations should be updated
75  to version 0.10.4 or subsequent versions.</p>
76 <p>
77  This version is used in private IRC networks and is known to run quite
78  stable and flawless although it is not tested in huge IRC networks under
79  heavy load yet. There are still missing features, but the current version
80  should provide everything you need during &quot;normal&quot; IRC sessions.
81 </p>
82 <p>
83  Read more about our private IRC network on these
84  <a href="http://irc.barton.de/">web pages</a>.
85 </p>
86 <p>
87  I'm glad to receive feedback, bug reports (best choice for this is the
88  <a href="#bugs">Bug-Tracker</a>) and patches. Go on, use the source
89  and keep on hacking!
90 </p>
91 <p>
92  You can reach me (Alex Barton) via E-Mail:
93  <a href="mailto:alex@barton.de">alex@barton.de</a>.
94 </p>
95
96 <h2 id="why">Advantages</h2>
97 <p>
98  Why should you use ngIRCd? Because ...
99 </p>
100 <ul>
101  <li>there are no problems with servers on changing or non-static IP addresses.
102  <li>there is a small and lean configuration file.
103  <li>there is a free, modern and open source C source code.
104  <li>it is still under active development.
105 </ul>
106
107 <h2 id="platforms">Supported platforms</h2>
108 <p>
109  ngIRCd is tested on a regular basis on the following platform
110  (version numbers used in parenthesis). These are the officially
111  supported systems.
112 </p>
113 <ul>
114  <li>AIX (3.2.5, IBM XL C Compiler)
115  <li>A/UX (3.x, original Apple C Compiler or GNU C)
116  <li><a href="http://www.freebsd.org/">FreeBSD</a> (4.5/i386, GNU C)
117  <li><a href="http://www.hp.com/">HP-UX</a> (10.20, GNU C)
118  <li><a href="http://www.hp.com/">HP-UX</a> (9.10/m68k, HP-UX cc)
119  <li>IRIX (6.5, SGI MIPSpro C 7.30)
120  <li><a href="http://www.linux.org/">Linux</a> (2.2.x/i386, 2.4.x/i386 and 2.4.x/hppa, GNU C)
121  <li><a href="http://www.apple.com/macosx/">Mac OS X</a> (10.x, GNU C 2.95.x/3.x)
122  <li><a href="http://www.netbsd.org/">NetBSD</a> (1.5.2/i386 and 1.5.3/m68k, GNU C)
123  <li><a href="http://www.obenbsd.org/">OpenBSD</a> (3.4/i386)
124  <li><a href="http://www.sun.com/">Solaris</a> (2.5.1 and 2.6, GNU C)
125  <li>Windows with <a href="http://sources.redhat.com/cygwin/">Cygwin</a> (GNU C)
126 </ul>
127 <p>
128  As ngIRCd relies on UNIX standards and uses GNU automake and GNU autoconf
129  there are good chances that it also supports UNIX-based operating systems.
130 </p>
131
132 <h2 id="docu">Documentation</h2>
133 <p>
134  There's a bit of documentation in the source code package. One's located
135  in the main directory (e.g. INSTALL, README, NEWS and COPYING) others in
136  subdirectories like <code>&quot;doc&quot;</code> (e.g. GIT.txt, FAQ.txt
137  and sample configuration files like sample-ngircd.conf).
138 </p>
139 <p>Parts of the documentation are available here:</p>
140 <ul>
141  <li><a href="doc/README">README</a>
142  <li><a href="doc/INSTALL">INSTALL</a>
143 </ul>
144 <ul>
145  <li><a href="doc/AUTHORS">AUTHORS</a>
146  <li><a href="doc/COPYING">COPYING</a>
147  <li><a href="doc/GIT.txt">GIT.txt</a>
148  <li><a href="doc/ChangeLog">ChangeLog</a>
149  <li><a href="doc/FAQ.txt">FAQ.txt</a>
150  <li><a href="doc/NEWS">NEWS</a>
151  <li><a href="doc/Platforms.txt">Platforms.txt</a>
152  <li><a href="doc/Protocol.txt">Protocol.txt</a>
153  <li><a href="doc/RFC.txt">RFC.txt</a>
154  <li><a href="doc/SSL.txt">SSL.txt</a>
155 </ul>
156 <ul>
157  <li><a href="doc/sample-ngircd.conf">sample-ngircd.conf</a>
158 </ul>
159 <ul>
160  <li><a href="doc/README-AUX.txt">README-AUX.txt</a>
161  <li><a href="doc/README-BeOS.txt">README-BeOS.txt</a> (German)
162 </ul>
163
164 <h2 id="ml">Mailing List</h2>
165 <p>
166  There is a mailing list which deals with the &quot;technical&quot;
167  questions concerning ngIRCd: compilation, installation, configuration,
168  and the further development. Updates and news are announced there.
169 </p>
170 <p>Please subscribe using the <a href="http://arthur.barton.de/mailman/listinfo/ngircd-ml">homepage of the list</a>.
171 <p>All postings are archived <a href="http://arthur.barton.de/pipermail/ngircd-ml/">here</a>.
172
173 <h2 id="install">Installation</h2>
174 <p>
175  ngIRCd's target are systems based on or similar to UNIX. There
176  shouldn't be any problem on a fairly modern UNIX that's supported by
177  GNU automake and GNU autoconf. If you run into compile problems
178  perhaps you should give GNU C a try (version 2.95 or newer).
179 </p>
180 <p>
181  Typical usage is:
182 </p>
183 <blockquote><p><code>
184  tar xzf ngircd-&lt;version&gt;.tar.gz<br>
185  cd ngircd-&lt;version&gt;<br>
186  ./configure<br>
187  make
188 </code></p></blockquote>
189 <p>
190  Now there's the binary executable server file in <code>src/ngircd</code>
191  (&quot;<code>ngircd</code>&quot; in most cases).
192 </p>
193 <blockquote><p><code>
194  make install
195 </code></p></blockquote>
196 <p>
197  The binary executable is now installed in <code>/usr/local/sbin</code>.
198 </p>
199 <p>
200  The server looks for the configuration file <code>ngircd.conf</code> in
201  <code>/usr/local/etc</code>. A sample configuration file can be found in
202  <code>doc</code>.
203 </p>
204 <p>
205  Further help on installation and configuration can be found in
206  <code><a href="doc/INSTALL">INSTALL</a></code>.
207 </p>
208
209 <h2 id="download">Download</h2>
210 <h3 id="source">Source Code</h3>
211 <dl>
212  <dt><strong>ngIRCd 0.11.1</strong> (2008-02-26):</dt>
213  <dd>
214         <p>Server: <em>berlios.de</em> (<a href="ftp://ftp.berlios.de/pub/ngircd/">ftp</a>)</p>
215         <ul>
216                 <li>ngircd-0.11.1.tar.gz:
217                     <a href="ftp://ftp.berlios.de/pub/ngircd/ngircd-0.11.1.tar.gz">ftp</a>
218         </ul>
219         <p>Server: <em>ngircd.barton.de</em> (<a href="ftp://ngircd.barton.de/pub/ngircd/">ftp</a>)</p>
220         <ul>
221                 <li>ngircd-0.11.1.tar.gz:
222                     <a href="ftp://ngircd.barton.de/pub/ngircd/ngircd-0.11.1.tar.gz">ftp</a>.
223         </ul>
224  </dd>
225 </dl>
226 <p>
227  All previous released versions, GnuPG signatures as well as available test
228  releases of upcoming versions are available via FTP from
229  <a href="ftp://ngircd.barton.de/pub/ngircd/">ngircd.barton.de</a> and
230  <a href="ftp://ftp.berlios.de/pub/ngircd/">ftp.berlios.de</a>.
231 </p>
232 <h3 id="packages">Packages</h3>
233 <p>
234  If you are using one of the following distributions, you can use their packages:
235 </p>
236 <ul>
237  <li>
238   <a href="http://amiga.sourceforge.net/">Amiga.sf</a>:
239   <a href="http://amiga.sourceforge.net/index.php?showpackage=ngIRCd">Port</a>
240  </li>
241  <li>
242   <a href="http://darwinports.opendarwin.org/">DarwinPorts</a>:
243   <a href="http://darwinports.opendarwin.org/ports/?by=name&amp;substr=ngircd">Port</a>
244  </li>
245  <li>
246   <a href="http://www.debian.org/">Debian Linux</a>:
247   <a href="http://packages.debian.org/ngircd">deb</a>
248  </li>
249  <li>
250   <a href="http://www.freebsd.org/">FreeBSD</a>:
251   <a href="http://www.freebsd.org/cgi/ports.cgi?query=ngircd&amp;stype=all">Port</a>
252  </li>
253  <li>
254   <a href="http://www.gentoo.org/">Gentoo Linux</a>:
255   <a href="http://packages.gentoo.org/packages/?category=net-irc;name=ngircd">ebuild</a>
256  </li>
257  <li>
258   <a href="http://www.opensuse.org/">OpenSUSE</a>:
259   <a href="http://software.opensuse.org/download/server:/irc/">rpm</a>
260  </li>
261  <li>
262   <a href="http://www.ubuntu.com/">Ubuntu Linux</a>:
263   <a href="http://packages.ubuntu.com/ngircd">deb</a>
264  </li>
265 </ul>
266 <p>
267  <q>Inofficial</q> packages:
268 </p>
269 <ul>
270  <li>
271   <a href="http://www.debian.org/">Debian Linux</a>:
272   <a href="ftp://arthur.barton.de/debian/pool/main/n/ngircd/">deb</a>
273   (Autor: Alex Barton)
274  </li>
275 </ul>
276
277 <h2 id="people">Contact</h2>
278 <p>
279  Idea and most parts of the current code:
280  Alexander Barton (<a href="mailto:alex@barton.de">alex@barton.de</a>).
281 </p>
282 <p>
283  Thanks to
284  Ilja Osthoff (<a href="mailto:ilja@glide.ath.cx">ilja@glide.ath.cx</a>)
285  for translating parts of the documentation into english and
286  G&ouml;tz Hoffart (<a href="mailto:goetz@hoffart.de">goetz@hoffart.de</a>)
287  for translating the web page.
288 </p>
289 <p>
290  If you find bugs or have some ideas for enhancements, please file them
291  into the <a href="#bugs">bug tracker</a>. In addition, there is a
292  <a href="#ml">mailing list</a> for discussions concerning the ngIRCd.
293 </p>
294 <p>BTW: Patches are welcome ;-)</p>
295 <p>ngIRCd on IRC: <a href="irc://irc.barton.de/ngircd">irc://irc.barton.de/ngircd</a>.</p>
296 <h2 id="git">GIT Repository</h2>
297 <p>
298  The source and all files belonging to ngIRCd are managed using
299  <a hreflang="en" href="http://git.or.cz/">GIT</a>.
300  Anonymous access is available, read: <a href="doc/GIT.txt">GIT.txt</a>.
301 </p>
302 <p>
303  The repository is online available through HTTP:
304  <a href="http://ngircd.barton.de/cgi-bin/gitweb.cgi?p=ngircd.git">ngIRCd GIT Reposidtory</a>.
305 </p>
306
307 <h2 id="bugs">Bug Tracker</h2>
308 <p>
309  In order to keep track of feature requests and found bugs there's a
310  Bug Tracking system: <a href="http://ngircd.barton.de/bugzilla/index.cgi">Bugzilla</a>
311 </p>
312 <p>
313  In case you found a bug please check
314  <a href="http://ngircd.barton.de/bugzilla/enter_bug.cgi">Bug-Report</a>
315  and describe the circumstances. Thank you!
316 </p>
317 <p>
318  In addition you can <a href="http://ngircd.barton.de/bugzilla/query.cgi">inform</a>
319  about known and perhaps fixed bugs.
320 </p>
321
322 <h2 id="history">History</h2>
323 <p>
324  Please read the files
325  <a href="doc/NEWS">NEWS</a> and
326  <a href="doc/ChangeLog">ChangeLog</a>
327  for detailed information.
328 </p>
329
330 <!-- Footer -->
331 <hr style="margin-top: 0.75em;">
332 <p style="text-align: center">
333  Thanks to:<br>
334  <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>
335 </p>
336 <hr>
337 <p>
338  <img src="valid-html401.gif" style="float: right;" alt="Valid HTML 4.01!" height="31" width="88">
339  <small>
340   Version: $Id$
341   <br>
342   <a hreflang="en" href="http://validator.w3.org/check?uri=http%3A%2F%2Fngircd.barton.de%2Findex.html.en">Validate</a> page.<br>
343   Contact: Alexander Barton, E-Mail: <a href="mailto:alex@barton.de">alex@barton.de</a>.<br>
344   Thanks to <a href="mailto:goetz@hoffart.de">G&ouml;tz Hoffart</a> for cleaning up this page and the english translation!
345  </small>
346 </p>
347
348 </body>
349 </html>