]> arthur.barton.de Git - ngircd.git/blobdiff - INSTALL.md
Update included Debian package configuration
[ngircd.git] / INSTALL.md
index 56c7cc52352f68aea6e9086205d59745a9a37198..28b1da337bbe5f13e2e5c008a0b7a65dfbf83b9f 100644 (file)
@@ -1,7 +1,7 @@
 # [ngIRCd](https://ngircd.barton.de) - Internet Relay Chat Server
 
-This document explains how to install ngIRCd, the lightweight Internet Relay
-Chat (IRC) server.
+This document explains how to install and configure ngIRCd, the lightweight
+Internet Relay Chat (IRC) server.
 
 The first section lists noteworthy changes to earlier releases; you definitely
 should read this when upgrading your setup! But you can skip over this section
@@ -10,6 +10,10 @@ when you do a fresh installation.
 All the subsequent sections describe the steps required to install and
 configure ngIRCd.
 
+Please see the file `doc/QuickStart.md` in the `doc/` directory and
+[online](https://ngircd.barton.de/doc/QuickStart.md) on the homepage for some
+configuration examples.
+
 ## Upgrade Information
 
 Differences to version 25
@@ -349,11 +353,12 @@ standard locations.
   Enable support for SSL/TLS using OpenSSL or GnuTLS libraries.
   See `doc/SSL.txt` for details.
 
-- IPv6:
+- IPv6 (autodetected by default):
 
-  `--enable-ipv6`
+  `--enable-ipv6` / `--disable-ipv6`
 
-  Adds support for version 6 of the Internet Protocol.
+  Enable (disable) support for version 6 of the Internet Protocol, which should
+  be available on most modern UNIX-like operating systems by default.
 
 ## Configuration
 
@@ -361,6 +366,10 @@ Please have a look at the `ngircd(8)` and `ngircd.conf(5)` manual pages for
 details and all possible command line and configuration options -- **and don't
 forget to run `ngircd --configtest` to validate your configuration file!**
 
+The file `doc/QuickStart.md` in the `doc/` directory and
+[online](https://ngircd.barton.de/doc/QuickStart.md) on the homepage has some
+configuration examples, you should take a look :-)
+
 After installing ngIRCd, a sample configuration file will be set up (if it
 does not exist already). By default, when installing from sources, the file is
 named `/usr/local/etc/ngircd.conf` (other common names, especially for