diff options
| author | Alexander Barton <alex@barton.de> | 2021-12-30 20:01:44 +0100 |
|---|---|---|
| committer | Alexander Barton <alex@barton.de> | 2021-12-30 20:01:44 +0100 |
| commit | 3675c7567caf65e8fb0ed0390083a6d33919d26f (patch) | |
| tree | 984ff88c4c930b21289f933671f9aa9d8c6bcf6a /INSTALL.md | |
| parent | 97ffec3d64eb21c3d346104910113542e831aadf (diff) | |
| download | ngircd-3675c7567caf65e8fb0ed0390083a6d33919d26f.tar.gz ngircd-3675c7567caf65e8fb0ed0390083a6d33919d26f.zip | |
Enhance documentation a bit, add doc/QuickStart.md
And this file could well be expanded!
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/INSTALL.md b/INSTALL.md index 56c7cc52..b5ad20ed 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -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 @@ -361,6 +365,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 |