doc/QuickStart.md

   1 # [ngIRCd](https://ngircd.barton.de) - Internet Relay Chat Server
   2
   3 This *Quick Start* document explains how to configure ngIRCd, the lightweight
   4 Internet Relay Chat (IRC) server, using some "real world" scenarios.
   5
   6 ## Simple Single-Instance Server
   7
   8 ngIRCd needs at least a valid IRC server name configured, therefore the
   9 simplest configuration file looks like this:
  10
  11 ``` ini
  12 [Global]
  13 Name = irc.example.net
  14 ````
  15
  16 This results in the following *warning* in the logs when starting the daemon:
  17 `No administrative information configured but required by RFC!` -- which works,
  18 but is a bit ugly. So let's fix that by adding some *admin info*:
  19
  20 ``` ini
  21 [Global]
  22 Name = irc.example.net
  23 AdminInfo1 = Example IRC Server
  24 AdminInfo2 = Anywhere On Earth
  25 AdminEMail = admin@irc.example.net
  26 ```
  27
  28 *Please Note*: The server `Name` looks like a DNS host name, but it is not: in
  29 fact it is not related to your server's fully qualified domain name (FQDN) in
  30 any way and can be an arbitrary string -- but which *must* contain at least
  31 one dot (".") character!
  32
  33 ## Add a Local IRC Operator
  34
  35 Some IRC commands, like `REHASH` which reloads the server configuration on the
  36 fly, require the user to authenticate to the daemon to become an *IRC
  37 Operator* first.
  38
  39 So let's configure an *Operator* account in the configuration file (in
  40 addition to what we configured above):
  41
  42 ``` ini
  43 [Operator]
  44 # ID of the operator (may be different of the nickname)
  45 Name = BigOp
  46 # Password of the IRC operator
  47 Password = secret
  48 # Optional Mask from which /OPER will be accepted
  49 ;Mask = *!ident@somewhere.example.com
  50 ```
  51
  52 Now you can use the IRC command `OPER BigOp secret` to get *IRC Operator*
  53 status on that server.
  54
  55 Please choose a sensible password, and keep in mind that the *name* is not
  56 related to the *nickname* used by the user at all!
  57
  58 We don't make use of the `Mask` setting in the example above (commented out
  59 with the `;` character), but it is a good idea to enable it whenever possible!
  60
  61 And you can have as many *Operator blocks* as you like, configuring multiple
  62 different IRC Operators.