Include directive

From UnrealIRCd documentation wiki
Jump to: navigation, search

The include directive allows you to include other configuration files. This way you can split up your configuration instead of having one large unrealircd.conf.

Syntax

include "<file-name-or-URL>";

Commonly included files

UnrealIRCd ships with a number of configuration files out-of-the-box that you can choose to include:

  • modules.full.conf: these contain all the modules, you almost always want to load this file
  • badwords.conf: needed to make channel mode +G and user mode +G work ("bad words filter")
  • spamfilter.conf: spamfilter (example) configuration
  • aliases/anope.conf: recommended if you use anope services, provides a number of commands including: /NS, /NICKSERV, /CS, /CHANSERV, etc.
  • aliases/atheme.conf: similar file if you use atheme services

Example

include "modules.default.conf"; /* Load all modules */
include "operclass.default.conf"; /* Default operclass blocks */
include "spamfilter.conf"; /* Spamfilter configuration */
include "badwords.conf";
include "help.conf";
/* CUSTOM example */
include "opers.conf"; /* Oper blocks are all in this file*/
include "links.conf"; /* All link blocks */

If you have enabled "Remote includes" (this is the default on Windows) then you can also use URL's:

include "https://www.example.com/network/links.conf"; /* HTTP example */
include "https://user:password@www.example.org/network/opers.conf"; /* HTTPS example WITH username/password (HTTP Basic Auth) */

If you use remote includes then we recommend to use HTTPS and not HTTP, as with HTTP your included configuration file go over the wire in plaintext and may be read by 3rd parties.