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 quite easy to configure and runs as a single-node server or can
  11 be part of a network of ngIRCd servers in a LAN or across the internet. It
  12 optionally supports the IPv6 protocol, SSL/TLS-protected client-server and
  13 server-server links, the Pluggable Authentication Modules (PAM) system for user
  14 authentication, IDENT requests, and character set conversion for legacy
  15 clients.
  16
  17 The name ngIRCd stands for *next-generation IRC daemon*, which is a little bit
  18 exaggerated: *lightweight Internet Relay Chat server* most probably would have
  19 been a better name :-)
  20
  21 Please see the `INSTALL.md` document for installation and upgrade information,
  22 online available here: <https://ngircd.barton.de/doc/INSTALL.md>!
  23
  24 ## Status
  25
  26 Development of *ngIRCd* started back in 2001: The server has been written from
  27 scratch in C, tries to follow all relevant standards, and is not based on the
  28 forefather, the daemon of the IRCNet.
  29
  30 It is not the goal of ngIRCd to implement all the nasty behaviors of the
  31 original `ircd` or corner-cases in the RFCs, but to implement most of the useful
  32 commands and semantics that are used by existing clients.
  33
  34 *ngIRCd* is used as the daemon in real-world in-house and public IRC networks
  35 and included in the package repositories of various operating systems.
  36
  37 ## Features (or: why use ngIRCd?)
  38
  39 - Well arranged (lean) configuration file.
  40 - Simple to build, install, configure, and maintain.
  41 - Supports IPv6 and SSL.
  42 - Can use PAM for user authentication.
  43 - Lots of popular user and channel modes are implemented.
  44 - Supports "cloaking" of users.
  45 - No problems with servers that have dynamic IP addresses.
  46 - Freely available, modern, portable and tidy C source.
  47 - Wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
  48   IRIX, Linux, macOS, NetBSD, OpenBSD, Solaris and Windows with WSL or Cygwin.
  49
  50 ## Documentation
  51
  52 The **homepage** of the ngIRCd project is <https://ngircd.barton.de>.
  53
  54 Installation of ngIRCd is described in the file `INSTALL.md` in the source
  55 directory; please see the file `doc/QuickStart.md` in the `doc/` directory for
  56 some configuration examples.
  57
  58 More documentation can be found in the `doc/` directory and
  59 [online](https://ngircd.barton.de/documentation).
  60
  61 ## Downloads & Source Code
  62
  63 You can find the latest information about the ngIRCd and the most recent
  64 stable release on the [news](https://ngircd.barton.de/news) and
  65 [downloads](https://ngircd.barton.de/download) pages of the homepage.
  66
  67 Visit our source code repository at [GitHub](https://github.com) if you are
  68 interested in the latest development code: <https://github.com/ngircd/ngircd>.
  69
  70 ## Problems, Bugs, Patches
  71
  72 Please don't hesitate to contact us if you encounter problems:
  73
  74 - On IRC: <irc://irc.barton.de/ngircd>
  75 - Via the mailing list: <ngircd-ml@ngircd.barton.de>
  76
  77 See <https://ngircd.barton.de/support> for details.
  78
  79 If you find any bugs in ngIRCd (which most probably will be there ...), please
  80 report them to our issue tracker at GitHub:
  81
  82 - Bug tracker: <https://github.com/ngircd/ngircd/issues>
  83 - Patches, "pull requests": <https://github.com/ngircd/ngircd/pulls>
  84
  85 [IRC]: https://wikipedia.org/wiki/Internet_Relay_Chat
  86 [GPL]: https://wikipedia.org/wiki/GNU_General_Public_License