Return to README.md CVS log

Up to [local] / ircnowd

Annotation of ircnowd/README.md, Revision 1.1.1.1

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