ngircd/templates/ngircd.conf.j2
author Luke Hoersten <luke@hoersten.org>
Sat, 04 Jul 2020 11:00:20 -0500
changeset 113 d843011c249d
permissions -rw-r--r--
Got ngircd + atheme services roles working.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
113
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     1
#
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     2
# This is a sample configuration file for the ngIRCd IRC daemon, which must
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     3
# be customized to the local preferences and needs.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     4
#
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     5
# Comments are started with "#" or ";".
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     6
#
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     7
# A lot of configuration options in this file start with a ";". You have
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     8
# to remove the ";" in front of each variable to actually set a value!
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
     9
# The disabled variables are shown with example values for completeness only
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    10
# and the daemon is using compiled-in default settings.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    11
#
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    12
# Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    13
# server interprets the configuration file as expected!
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    14
#
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    15
# Please see ngircd.conf(5) for a complete list of configuration options
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    16
# and their descriptions.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    17
#
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    18
# The original can be found at:
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    19
# /usr/share/doc/ngircd/sample-ngircd.conf.gz
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    20
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    21
[Global]
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    22
        # The [Global] section of this file is used to define the main
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    23
        # configuration of the server, like the server name and the ports
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    24
        # on which the server should be listening.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    25
        # These settings depend on your personal preferences, so you should
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    26
        # make sure that they correspond to your installation and setup!
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    27
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    28
        # Server name in the IRC network, must contain at least one dot
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    29
        # (".") and be unique in the IRC network. Required!
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    30
        Name = {{ngircd_name}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    31
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    32
        # Information about the server and the administrator, used by the
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    33
        # ADMIN command. Not required by server but by RFC!
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    34
        AdminInfo1 = {{ngircd_admin_name}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    35
        ;AdminInfo2 = Debian City
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    36
        AdminEMail = {{ngircd_admin_email}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    37
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    38
        # Text file which contains the ngIRCd help text. This file is required
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    39
        # to display help texts when using the "HELP <cmd>" command.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    40
        ;HelpFile = /usr/share/doc/ngircd/Commands.txt
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    41
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    42
        # Info text of the server. This will be shown by WHOIS and
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    43
        # LINKS requests for example.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    44
        Info = {{ngircd_name}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    45
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    46
        # Comma separated list of IP addresses on which the server should
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    47
        # listen. Default values are:
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    48
        # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    49
        # so the server listens on all IP addresses of the system by default.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    50
        Listen = 127.0.0.1
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    51
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    52
        # Text file with the "message of the day" (MOTD). This message will
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    53
        # be shown to all users connecting to the server:
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    54
        MotdFile = /etc/ngircd/ngircd.motd
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    55
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    56
        # A simple Phrase (<127 chars) if you don't want to use a motd file.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    57
        ;MotdPhrase = "Hello. This is the Debian default MOTD sentence"
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    58
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    59
        # The name of the IRC network to which this server belongs. This name
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    60
        # is optional, should only contain ASCII characters, and can't contain
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    61
        # spaces. It is only used to inform clients. The default is empty,
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    62
        # so no network name is announced to clients.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    63
        ;Network = aIRCnetwork
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    64
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    65
        # Global password for all users needed to connect to the server.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    66
        # (Default: not set)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    67
        ;Password = wealllikedebian
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    68
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    69
        # This tells ngIRCd to write its current process ID to a file.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    70
        # Note that the pidfile is written AFTER chroot and switching the
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    71
        # user ID, e.g. the directory the pidfile resides in must be
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    72
        # writable by the ngIRCd user and exist in the chroot directory.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    73
        # Keep this setting in sync with PIDFILE in /etc/init.d/ngircd
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    74
        PidFile = /var/run/ngircd/ngircd.pid
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    75
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    76
        # Ports on which the server should listen. There may be more than
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    77
        # one port, separated with ",". (Default: 6667)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    78
        ;Ports = 6667, 6668, 6669
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    79
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    80
        # Group ID under which the ngIRCd should run; you can use the name
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    81
        # of the group or the numerical ID. ATTENTION: For this to work the
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    82
        # server must have been started with root privileges!
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    83
        # Keep this setting in sync with DAEMONUSER in the init script and/or
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    84
        # the Group= setting in service file.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    85
        ServerGID = irc
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    86
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    87
        # User ID under which the server should run; you can use the name
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    88
        # of the user or the numerical ID. ATTENTION: For this to work the
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    89
        # server must have been started with root privileges! In addition,
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    90
        # the configuration and MOTD files must be readable by this user,
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    91
        # otherwise RESTART and REHASH won't work!
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    92
        # Keep this setting in sync with DAEMONUSER in the init script and/or
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    93
        # the User= setting in service file.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    94
        ServerUID = irc
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    95
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    96
[Limits]
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    97
        # Define some limits and timeouts for this ngIRCd instance. Default
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    98
        # values should be safe, but it is wise to double-check :-)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
    99
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   100
        # The server tries every <ConnectRetry> seconds to establish a link
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   101
        # to not yet (or no longer) connected servers.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   102
        ConnectRetry = 60
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   103
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   104
        # Number of seconds after which the whole daemon should shutdown when
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   105
        # no connections are left active after handling at least one client
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   106
        # (0: never, which is the default).
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   107
        # This can be useful for testing or when ngIRCd is started using
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   108
        # "socket activation" with systemd(8), for example.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   109
        ;IdleTimeout = 0
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   110
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   111
        # Maximum number of simultaneous in- and outbound connections the
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   112
        # server is allowed to accept (0: unlimited):
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   113
        MaxConnections = 500
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   114
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   115
        # Maximum number of simultaneous connections from a single IP address
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   116
        # the server will accept (0: unlimited):
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   117
        MaxConnectionsIP = 10
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   118
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   119
        # Maximum number of channels a user can be member of (0: no limit):
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   120
        MaxJoins = 10
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   121
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   122
        # Maximum length of an user nickname (Default: 9, as in RFC 2812).
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   123
        # Please note that all servers in an IRC network MUST use the same
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   124
        # maximum nickname length!
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   125
        ;MaxNickLength = 9
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   126
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   127
        # Maximum penalty time increase in seconds, per penalty event. Set to -1
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   128
        # for no limit (the default), 0 to disable penalties altogether. The
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   129
        # daemon doesn't use penalty increases higher than 2 seconds during
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   130
        # normal operation, so values greater than 1 rarely make sense.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   131
        ;MaxPenaltyTime = -1
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   132
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   133
        # Maximum number of channels returned in response to a /list
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   134
        # command (0: unlimited):
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   135
        ;MaxListSize = 100
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   136
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   137
        # After <PingTimeout> seconds of inactivity the server will send a
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   138
        # PING to the peer to test whether it is alive or not.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   139
        PingTimeout = 120
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   140
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   141
        # If a client fails to answer a PING with a PONG within <PongTimeout>
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   142
        # seconds, it will be disconnected by the server.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   143
        PongTimeout = 20
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   144
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   145
[Options]
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   146
        # Optional features and configuration options to further tweak the
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   147
        # behavior of ngIRCd. If you want to get started quickly, you most
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   148
        # probably don't have to make changes here -- they are all optional.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   149
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   150
        # List of allowed channel types (channel prefixes) for newly created
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   151
        # channels on the local server. By default, all supported channel
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   152
        # types are allowed. Set this variable to the empty string to disallow
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   153
        # creation of new channels by local clients at all.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   154
        ;AllowedChannelTypes = #&+
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   155
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   156
        # Are remote IRC operators allowed to control this server, e.g.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   157
        # use commands like CONNECT, SQUIT, DIE, ...?
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   158
        ;AllowRemoteOper = no
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   159
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   160
        # A directory to chroot in when everything is initialized. It
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   161
        # doesn't need to be populated if ngIRCd is compiled as a static
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   162
        # binary. By default ngIRCd won't use the chroot() feature.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   163
        # ATTENTION: For this to work the server must have been started
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   164
        # with root privileges!
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   165
        ;ChrootDir = /var/empty
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   166
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   167
        # Set this hostname for every client instead of the real one.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   168
        # Use %x to add the hashed value of the original hostname.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   169
        {% if ngircd_cloak is defined %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   170
        CloakHost = {{ngircd_cloak}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   171
        {% endif %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   172
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   173
        # Use this hostname for hostname cloaking on clients that have the
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   174
        # user mode "+x" set, instead of the name of the server.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   175
        # Use %x to add the hashed value of the original hostname.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   176
        ;CloakHostModeX = cloaked.user
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   177
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   178
        # The Salt for cloaked hostname hashing. When undefined a random
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   179
        # hash is generated after each server start.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   180
        ;CloakHostSalt = abcdefghijklmnopqrstuvwxyz
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   181
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   182
        # Set every clients' user name to their nickname
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   183
        ;CloakUserToNick = yes
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   184
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   185
        # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   186
        ;ConnectIPv6 = yes
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   187
        ;ConnectIPv4 = yes
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   188
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   189
        # Default user mode(s) to set on new local clients. Please note that
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   190
        # only modes can be set that the client could set using regular MODE
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   191
        # commands, you can't set "a" (away) for example! Default: none.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   192
        ;DefaultUserModes = i
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   193
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   194
        # Do DNS lookups when a client connects to the server.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   195
        ;DNS = yes
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   196
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   197
        # Do IDENT lookups if ngIRCd has been compiled with support for it.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   198
        # Users identified using IDENT are registered without the "~" character
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   199
        # prepended to their user name.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   200
        ;Ident = yes
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   201
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   202
        # Directory containing configuration snippets (*.conf), that should
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   203
        # be read in after parsing this configuration file.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   204
        ;IncludeDir = /etc/ngircd/conf.d
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   205
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   206
        # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   207
        # by censoring some information like idle time, logon time, etc.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   208
        ;MorePrivacy = no
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   209
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   210
        # Normally ngIRCd doesn't send any messages to a client until it is
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   211
        # registered. Enable this option to let the daemon send "NOTICE *"
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   212
        # messages to clients while connecting.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   213
        ;NoticeBeforeRegistration = no
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   214
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   215
        # Should IRC Operators be allowed to use the MODE command even if
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   216
        # they are not(!) channel-operators?
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   217
        OperCanUseMode = yes
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   218
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   219
        # Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   220
        ;OperChanPAutoOp = yes
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   221
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   222
        # Mask IRC Operator mode requests as if they were coming from the
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   223
        # server? (This is a compatibility hack for ircd-irc2 servers)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   224
        ;OperServerMode = no
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   225
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   226
        # Use PAM if ngIRCd has been compiled with support for it.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   227
        # Users identified using PAM are registered without the "~" character
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   228
        # prepended to their user name.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   229
        PAM = no
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   230
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   231
        # When PAM is enabled, all clients are required to be authenticated
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   232
        # using PAM; connecting to the server without successful PAM
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   233
        # authentication isn't possible.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   234
        # If this option is set, clients not sending a password are still
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   235
        # allowed to connect: they won't become "identified" and keep the "~"
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   236
        # character prepended to their supplied user name.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   237
        # Please note: To make some use of this behavior, it most probably
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   238
        # isn't useful to enable "Ident", "PAM" and "PAMIsOptional" at the
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   239
        # same time, because you wouldn't be able to distinguish between
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   240
        # Ident'ified and PAM-authenticated users: both don't have a "~"
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   241
        # character prepended to their respective user names!
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   242
        ;PAMIsOptional = no
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   243
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   244
        # When PAM is enabled, this value determines the used PAM
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   245
        # configuration.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   246
        # This setting allows to run multiple ngIRCd instances with
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   247
        # different PAM configurations on each instance.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   248
        # If you set it to "ngircd-foo", PAM will use
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   249
        # /etc/pam.d/ngircd-foo instead of the default
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   250
        # /etc/pam.d/ngircd.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   251
        ;PAMServiceName = ngircd
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   252
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   253
        # Let ngIRCd send an "authentication PING" when a new client connects,
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   254
        # and register this client only after receiving the corresponding
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   255
        # "PONG" reply.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   256
        ;RequireAuthPing = no
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   257
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   258
        # Silently drop all incoming CTCP requests.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   259
        ;ScrubCTCP = no
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   260
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   261
        # Syslog "facility" to which ngIRCd should send log messages.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   262
        # Possible values are system dependent, but most probably auth, daemon,
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   263
        # user and local1 through local7 are possible values; see syslog(3).
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   264
        # Default is "local5" for historical reasons, you probably want to
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   265
        # change this to "daemon", for example.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   266
        SyslogFacility = local1
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   267
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   268
        # Password required for using the WEBIRC command used by some
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   269
        # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   270
        # be used. (Default: not set)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   271
        ;WebircPassword = xyz
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   272
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   273
[SSL]
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   274
        # SSL-related configuration options. Please note that this section
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   275
        # is only available when ngIRCd is compiled with support for SSL!
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   276
        # So don't forget to remove the ";" above if this is the case ...
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   277
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   278
        # SSL Server Key Certificate
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   279
        ;CertFile = /etc/ssl/certs/server.crt
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   280
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   281
        # Select cipher suites allowed for SSL/TLS connections. This defaults
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   282
        # to HIGH:!aNULL:@STRENGTH (OpenSSL) or SECURE128 (GnuTLS).
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   283
        # See 'man 1ssl ciphers' (OpenSSL) or 'man 3 gnutls_priority_init'
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   284
        # (GnuTLS) for details.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   285
        # For OpenSSL:
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   286
        ;CipherList = HIGH:!aNULL:@STRENGTH:!SSLv3
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   287
        # For GnuTLS (this Debian package was linked against GnuTLS):
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   288
        CipherList = SECURE128:-VERS-SSL3.0
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   289
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   290
        # Diffie-Hellman parameters
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   291
        ;DHFile = /etc/ngircd/dhparams.pem
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   292
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   293
        # SSL Server Key
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   294
        ;KeyFile = /etc/ssl/private/server.key
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   295
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   296
        # password to decrypt SSLKeyFile (OpenSSL only)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   297
        # Note that this Debian package is linked against GnuTLS so this
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   298
        # option has no effect.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   299
        ;KeyFilePassword = secret
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   300
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   301
        # Additional Listen Ports that expect SSL/TLS encrypted connections
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   302
        ;Ports = 6697, 9999
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   303
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   304
{% for op in ngircd_ops %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   305
[Operator]
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   306
        # [Operator] sections are used to define IRC Operators. There may be
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   307
        # more than one [Operator] block, one for each local operator.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   308
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   309
        # ID of the operator (may be different of the nickname)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   310
        Name = {{op.name}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   311
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   312
        # Password of the IRC operator
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   313
        Password = {{op.pass}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   314
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   315
        # Optional Mask from which /OPER will be accepted
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   316
        # Mask = *!ident@somewhere.example.com
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   317
        {% if op.mask is defined %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   318
        Mask = {{op.mask}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   319
        {% endif %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   320
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   321
{% endfor %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   322
[Server]
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   323
{% for server in ngircd_servers %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   324
        # Other servers are configured in [Server] sections. If you
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   325
        # configure a port for the connection, then this ngircd tries to
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   326
        # connect to the other server on the given port; if not it waits
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   327
        # for the other server to connect.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   328
        # There may be more than one server block, one for each server.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   329
        #
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   330
        # Server Groups:
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   331
        # The ngIRCd allows "server groups": You can assign an "ID" to every
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   332
        # server with which you want this ngIRCd to link. If a server of a
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   333
        # group won't answer, the ngIRCd tries to connect to the next server
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   334
        # in the given group. But the ngircd never tries to connect to two
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   335
        # servers with the same group ID.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   336
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   337
        # IRC name of the remote server, must match the "Name" variable in
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   338
        # the [Global] section of the other server (when using ngIRCd).
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   339
        Name = {{server.name}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   340
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   341
        # Internet host name or IP address of the peer (only required when
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   342
        # this server should establish the connection).
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   343
        # Host = connect-to-host.example.net
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   344
        {% if server.host is defined %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   345
        Host = {{server.host}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   346
        {% endif %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   347
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   348
        # IP address to use as _source_ address for the connection. if
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   349
        # unspecified, ngircd will let the operating system pick an address.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   350
        ;Bind = 10.0.0.1
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   351
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   352
        # Port of the server to which the ngIRCd should connect. If you
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   353
        # assign no port the ngIRCd waits for incoming connections.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   354
        ;Port = 6667
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   355
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   356
        # Own password for the connection. This password has to be configured
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   357
        # as "PeerPassword" on the other server.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   358
        MyPassword = {{server.pass}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   359
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   360
        # Foreign password for this connection. This password has to be
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   361
        # configured as "MyPassword" on the other server.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   362
        PeerPassword = {{server.pass}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   363
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   364
        # Group of this server (optional)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   365
        ;Group = 123
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   366
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   367
        # Set the "Passive" option to "yes" if you don't want this ngIRCd to
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   368
        # connect to the configured peer (same as leaving the "Port" variable
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   369
        # empty). The advantage of this option is that you can actually
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   370
        # configure a port an use the IRC command CONNECT more easily to
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   371
        # manually connect this specific server later.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   372
        ;Passive = no
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   373
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   374
        # Connect to the remote server using TLS/SSL (Default: false)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   375
        ;SSLConnect = yes
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   376
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   377
        # Define a (case insensitive) list of masks matching nicknames that
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   378
        # should be treated as IRC services when introduced via this remote
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   379
        # server, separated by commas (",").
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   380
        # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   381
        # (which is the default).
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   382
        # When you are connecting IRC services which mask as a IRC server
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   383
        # and which use "virtual users" to communicate with, for example
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   384
        # "NickServ" and "ChanServ", you should set this parameter to
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   385
        # something like "*Serv" or "NickServ,ChanServ,XyzServ".
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   386
        {% if server.service_mask is defined %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   387
        ServiceMask = {{server.service_mask}}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   388
        {% endif %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   389
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   390
{% endfor %}
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   391
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   392
[Channel]
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   393
        # Pre-defined channels can be configured in [Channel] sections.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   394
        # Such channels are created by the server when starting up and even
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   395
        # persist when there are no more members left.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   396
        # Persistent channels are marked with the mode 'P', which can be set
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   397
        # and unset by IRC operators like other modes on the fly.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   398
        # There may be more than one [Channel] block, one for each channel.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   399
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   400
        # Name of the channel
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   401
        ;Name = #ngircd
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   402
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   403
        # Topic for this channel
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   404
        ;Topic = Our ngircd testing channel
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   405
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   406
        # Initial channel modes
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   407
        ;Modes = tnk
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   408
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   409
        # initial channel password (mode k)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   410
        ;Key = Secret
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   411
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   412
        # Key file, syntax for each line: "<user>:<nick>:<key>".
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   413
        # Default: none.
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   414
        ;KeyFile = /etc/ngircd/#chan.key
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   415
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   416
        # maximum users per channel (mode l)
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   417
        ;MaxUsers = 23
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   418
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   419
[Channel]
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   420
        # More [Channel] sections, if you like ...
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   421
d843011c249d Got ngircd + atheme services roles working.
Luke Hoersten <luke@hoersten.org>
parents:
diff changeset
   422
# -eof-