README.md

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