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 ## Status
  22
  23 Development of *ngIRCd* started back in 2001: The server has been written from
  24 scratch in C, tries to follow all relevant standards, and is not based on the
  25 forefather, the daemon of the IRCNet.
  26
  27 It is not the goal of ngIRCd to implement all the nasty behaviors of the
  28 original `ircd` or corner-cases in the RFCs, but to implement most of the useful
  29 commands and semantics that are used by existing clients.
  30
  31 *ngIRCd* is used as the daemon in real-world in-house and public IRC networks
  32 and included in the package repositories of various operating systems.
  33
  34 ## Advantages and strengths
  35
  36 - Well arranged (lean) configuration file.
  37 - Simple to build, install, configure, and maintain.
  38 - Supports IPv6 and SSL.
  39 - Can use PAM for user authentication.
  40 - Lots of popular user and channel modes are implemented.
  41 - Supports "cloaking" of users.
  42 - No problems with servers that have dynamic IP addresses.
  43 - Freely available, modern, portable and tidy C source.
  44 - Wide field of supported platforms, including AIX, A/UX, FreeBSD, HP-UX,
  45   IRIX, Linux, macOS, NetBSD, OpenBSD, Solaris and Windows with WSL or Cygwin.
  46
  47 ## Documentation
  48
  49 The **homepage** of the ngIRCd project is <https://ngircd.barton.de>.
  50
  51 The `INSTALL.md` document describes how to _install_ and _upgrade_ ngIRCd. It
  52 is included in all distribution archives and available online on
  53 [GitHub](https://github.com/ngircd/ngircd/blob/master/INSTALL.md).
  54
  55 Please see the file `doc/QuickStart.md` in the `doc/` directory or on
  56 [GitHub](https://github.com/ngircd/ngircd/blob/master/doc/QuickStart.md) for
  57 information about _setting up_ and _running_ ngIRCd, including some real-world
  58 configuration examples.
  59
  60 More information can be found in a couple of files in the `doc/` directory
  61 (online on [GitHub](https://github.com/ngircd/ngircd/tree/master/doc)) and in
  62 the [documentation section](https://ngircd.barton.de/documentation) on the
  63 [homepage of ngIRCd](https://ngircd.barton.de).
  64
  65 In addition, ngIRCd comes with two _manual pages_: `ngircd(8)` (for the daemon)
  66 and `ngircd.conf(5)` (for its configuration file). They have even more details
  67 and list all possible command line parameters and configuration options. You
  68 can read them with the `man` command (when they are installed locally on your
  69 system, e.g. `man 8 ngircd` and `man 5 ngircd.conf`) or online here:
  70
  71 - Daemon:
  72   [ngircd(8)](https://ngircd.barton.de/man/ngircd.8.html)
  73 - Configuration file:
  74   [ngircd.conf(5)](https://ngircd.barton.de/man/ngircd.conf.5.html)
  75
  76 ## Downloads & Source Code
  77
  78 You can find the latest information about the ngIRCd and the most recent
  79 stable release on the [news](https://ngircd.barton.de/news) and
  80 [downloads](https://ngircd.barton.de/download) pages of the homepage.
  81
  82 Visit our source code repository at [GitHub](https://github.com/ngircd/ngircd)
  83 if you are interested in the latest development code.
  84
  85 ## Problems, Bugs, Patches
  86
  87 Please don't hesitate to contact us if you encounter problems:
  88
  89 - On IRC: <irc://irc.barton.de/ngircd>
  90 - Via the mailing list: <ngircd@lists.barton.de>
  91
  92 See <https://ngircd.barton.de/support> for details.
  93
  94 If you find any bugs in ngIRCd (which most probably will be there ...), please
  95 report them to our issue tracker at GitHub:
  96
  97 - Bug tracker: <https://github.com/ngircd/ngircd/issues>
  98 - Patches, "pull requests": <https://github.com/ngircd/ngircd/pulls>
  99
 100 [IRC]: https://wikipedia.org/wiki/Internet_Relay_Chat
 101 [GPL]: https://wikipedia.org/wiki/GNU_General_Public_License