diff options
| author | Alexander Barton <alex@barton.de> | 2024-01-21 20:10:42 +0100 |
|---|---|---|
| committer | Alexander Barton <alex@barton.de> | 2024-01-21 20:15:47 +0100 |
| commit | 6fb8022949676c5a2c73c9629a4a4a1a67da389f (patch) | |
| tree | 9e202ad3bfdee7272b1e52559bca2fd2016bad50 /doc | |
| parent | 47d3872c607febc4ad56c24fa559828f96b6a208 (diff) | |
| download | ngircd-6fb8022949676c5a2c73c9629a4a4a1a67da389f.tar.gz ngircd-6fb8022949676c5a2c73c9629a4a4a1a67da389f.zip | |
Migrate info from INSTALL.md into doc/QuickStart.md
Move most information regarding configuring ngIRCd into the doc/QuickStart.md document, only describe building and installing ngIRCd in the INSTALL.md file. Don't duplicate content! Add references where this makes sense.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/QuickStart.md | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/doc/QuickStart.md b/doc/QuickStart.md index d2e23568..8e5e5464 100644 --- a/doc/QuickStart.md +++ b/doc/QuickStart.md @@ -19,8 +19,12 @@ everything was parsed as expected! ### Configuration File and Drop-in Directory -The `ngircd --configtest` command shows the name of the default configuration -file, too. For example `/etc/ngircd/ngircd.conf`. +After installing ngIRCd, a sample configuration file should have been set up if +none existed already. By default, when installing from sources, the file is +named `/usr/local/etc/ngircd.conf` (other common names, especially for +distribution packages, are `/etc/ngircd.conf` or `/etc/ngircd/ngircd.conf`). +Run the command `ngircd --configtest` to check the name of the configuration +file which is used by default on your local system. In addition, ngIRCd supports further configuration file snippets in a "drop-in" directory which is configured with the `IncludeDir` variable in the `[Options]` @@ -32,6 +36,11 @@ ore more new files in this include directory, overriding the defaults as needed. This way you don't get any clashes when updating ngIRCd to newer releases. +You can find the template of the sample configuration file in the `doc/` +directory as `sample-ngircd.conf` and +[online](https://ngircd.barton.de/doc/sample-ngircd.conf) on the homepage. It +contains all available options. + ## Configuration File Syntax The configuration consists of sections and parameters. @@ -45,6 +54,11 @@ Section and parameter names are not case sensitive. Please see the `ngircd.conf`(5) manual page for an in-depth description of the configuration file, its syntax and all supported configuration options. +The sample configuration file uses comments beginning with `#` *or* `;` -- this +is only for the better understanding of the file, both comment styles are +equal. The lines commented out with `;` show example or default settings, +whereas the lines using `#` are descriptions of the options. + ## Simple Single-Instance Server A good starting point is to configure a valid (and unique!) IRC server name |