1 61ac8be2 2020-03-29 alex # [ngIRCd](https://ngircd.barton.de) - Internet Relay Chat Server
3 61ac8be2 2020-03-29 alex ## Introduction
5 61ac8be2 2020-03-29 alex *ngIRCd* is a free, portable and lightweight *Internet Relay Chat* ([IRC])
6 61ac8be2 2020-03-29 alex server for small or private networks, developed under the terms of the GNU
7 61ac8be2 2020-03-29 alex General Public License ([GPL]); please see the file `COPYING` for licensing
10 a84cba8f 2020-05-26 alex The server is quite easy to configure, can handle dynamic IP addresses, and
11 a84cba8f 2020-05-26 alex optionally supports IDENT, IPv6 connections, SSL-protected links, and PAM for
12 a84cba8f 2020-05-26 alex user authentication as well as character set conversion for legacy clients. The
13 a84cba8f 2020-05-26 alex server has been written from scratch and is not based on the "forefather", the
14 a84cba8f 2020-05-26 alex daemon of the IRCNet.
16 a84cba8f 2020-05-26 alex The name ngIRCd means *next-generation IRC daemon*, which is a little bit
17 61ac8be2 2020-03-29 alex exaggerated: *lightweight Internet Relay Chat server* most probably would have
18 61ac8be2 2020-03-29 alex been a better name :-)
20 61ac8be2 2020-03-29 alex Please see the `INSTALL.md` document for installation and upgrade information,
21 61ac8be2 2020-03-29 alex online available here: <https://ngircd.barton.de/doc/INSTALL.md>!
25 a84cba8f 2020-05-26 alex ngIRCd should be quite feature-complete and stable to be used as a daemon in
26 a84cba8f 2020-05-26 alex real-world IRC networks.
28 61ac8be2 2020-03-29 alex It is not the goal of ngIRCd to implement all the nasty behaviors of the
29 61ac8be2 2020-03-29 alex original ircd, but to implement most of the useful commands and semantics
30 61ac8be2 2020-03-29 alex specified by the RFCs that are used by existing clients.
32 61ac8be2 2020-03-29 alex ## Features (or: why use ngIRCd?)
34 61ac8be2 2020-03-29 alex - Well arranged (lean) configuration file.
35 61ac8be2 2020-03-29 alex - Simple to build, install, configure, and maintain.
36 61ac8be2 2020-03-29 alex - Supports IPv6 and SSL.
37 61ac8be2 2020-03-29 alex - Can use PAM for user authentication.
38 61ac8be2 2020-03-29 alex - Lots of popular user and channel modes are implemented.
39 61ac8be2 2020-03-29 alex - Supports "cloaking" of users.
40 61ac8be2 2020-03-29 alex - No problems with servers that have dynamic IP addresses.
41 61ac8be2 2020-03-29 alex - Freely available, modern, portable and tidy C source.
42 61ac8be2 2020-03-29 alex - Wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
43 61ac8be2 2020-03-29 alex IRIX, Linux, macOS, NetBSD, OpenBSD, Solaris, and Windows with Cygwin.
44 61ac8be2 2020-03-29 alex - ngIRCd is being actively developed since 2001.
46 61ac8be2 2020-03-29 alex ## Documentation
48 61ac8be2 2020-03-29 alex The **homepage** of the ngIRCd project is <https://ngircd.barton.de>.
50 61ac8be2 2020-03-29 alex More documentation can be found in the `doc/` directory and
51 61ac8be2 2020-03-29 alex [online](https://ngircd.barton.de/documentation).
53 61ac8be2 2020-03-29 alex ## Downloads & Source Code
55 61ac8be2 2020-03-29 alex You can find the latest information about the ngIRCd and the most recent
56 61ac8be2 2020-03-29 alex stable release on the [news](https://ngircd.barton.de/news) and
57 61ac8be2 2020-03-29 alex [downloads](https://ngircd.barton.de/download) pages of the homepage.
59 61ac8be2 2020-03-29 alex Visit our source code repository at [GitHub](https://github.com) if you are
60 61ac8be2 2020-03-29 alex interested in the latest development code: <https://github.com/ngircd/ngircd>.
62 61ac8be2 2020-03-29 alex ## Problems, Bugs, Patches
64 61ac8be2 2020-03-29 alex Please don't hesitate to contact us if you encounter problems:
66 61ac8be2 2020-03-29 alex - On IRC: <irc://irc.barton.de/ngircd>
67 61ac8be2 2020-03-29 alex - Via the mailing list: <ngircd-ml@ngircd.barton.de>
69 61ac8be2 2020-03-29 alex See <http://ngircd.barton.de/support> for details.
71 61ac8be2 2020-03-29 alex If you find any bugs in ngIRCd (which most probably will be there ...), please
72 61ac8be2 2020-03-29 alex report them to our issue tracker at GitHub:
74 61ac8be2 2020-03-29 alex - Bug tracker: <https://github.com/ngircd/ngircd/issues>
75 61ac8be2 2020-03-29 alex - Patches, "pull requests": <https://github.com/ngircd/ngircd/pulls>
77 61ac8be2 2020-03-29 alex [IRC]: https://wikipedia.org/wiki/Internet_Relay_Chat
78 61ac8be2 2020-03-29 alex [GPL]: https://wikipedia.org/wiki/GNU_General_Public_License
