S2S-TLS: Convert SSL.txt to Markdown and update information given

[ngircd-alex.git] / doc / QuickStart.md

diff --git a/doc/QuickStart.md b/doc/QuickStart.md
index d2e23568f7982e699e8281cda0cba726c0e2663f..abea9cd42ae298c2af81126228958f671dc1ab07 100644 (file)
--- a/doc/QuickStart.md
+++ b/doc/QuickStart.md
@@ -10,7 +10,7 @@ defaults. These defaults are probably sufficient for very simple single-node
 setups, but most probably need further tweaking for more "advanced" setups.
 
 You can check the current settings by running `ngircd --configtest`. This
-command not only shows the settings, it shows error, warning and hits, if it
+command not only shows the settings, it shows error, warning and hints, if it
 detects any.
 
 Therefore it is definitely best practice to *always run this check* after
@@ -19,19 +19,29 @@ 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"
+In addition, ngIRCd supports configuration file snippets in a "drop-in"
 directory which is configured with the `IncludeDir` variable in the `[Options]`
 section and has a built-in default value (like `/etc/ngircd/ngircd.conf.d/`).
-All configuration files must match `*.conf`.
+All configuration files matching the `*.conf` pattern are read-in from this
+directory after the main `ngircd.conf` file.
 
-It is a good idea to not edit a default `ngircd.conf` file but to create one
+It is a good idea to not edit the default `ngircd.conf` file but to create one
 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 +55,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
@@ -105,3 +120,7 @@ with the `;` character), but it is a good idea to enable it whenever possible!
 
 And you can have as many *Operator blocks* as you like, configuring multiple
 different IRC Operators.
+
+## Configuring SSL/TLS Encryption
+
+Please see the file `SSL.md` for details.