Tip of the day: Check out Special users on how to give trusted users/bots more rights without making them IRCOp.

Include directive

From UnrealIRCd documentation wiki
Jump to navigation Jump to 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>";
include "<url>";

You can use:

  • A relative file name, such as include "modules.default.conf"; this will be read from your conf directory in UnrealIRCd.
  • A full path, such as include "/var/opt/whatever.conf"; or include "C:\\something\\xyz.conf";
  • An URL using Remote includes, such as: include "https://user:[email protected]/restricted/opers.conf";

Commonly included files

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

  • modules.default.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. This provides aliases such as the /NS and /IDENTIFY commands.
  • aliases/atheme.conf: same but for 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 "http://www.example.com/network/links.conf"; /* HTTP example */
include "https://user:[email protected]/network/opers.conf"; /* HTTPS example WITH username/password (HTTP Basic Auth) */

If you use remote includes then we recommend to use https for security. Do not use http, as http allows 3rd parties to (theoretically) intercept/see your configuration file with all its secrets and sensitive information.