diff --git a/doc/conf/examples/example.conf b/doc/conf/examples/example.conf index 1b9f70c35..543b95914 100644 --- a/doc/conf/examples/example.conf +++ b/doc/conf/examples/example.conf @@ -1,9 +1,15 @@ /* Configuration file for UnrealIRCd 6 * - * Simply copy this file to your conf/ directory, call it - * 'unrealircd.conf' and walk through it line by line (edit it!) + * Simply copy this file to your conf/ directory and call it 'unrealircd.conf' * - * Important: All lines, except { and } end with an ; + * If you are in a hurry then you can CTRL+F for: CHANGE THIS + * The items that must be changed are indicated with those two words. + * However, we actually recommend going through the file line by line + * and edit it where needed, so you can see all the basic items and + * what they are set to. + * + * BEFORE YOU PROCEED: + * Important: all lines, except { and } end with an ; * This is very important, if you miss a ; somewhere then the * configuration file parser will complain and the file will not * be processed correctly! @@ -17,7 +23,6 @@ * * Frequently Asked Questions: * https://www.unrealircd.org/docs/FAQ - * */ /* This is a comment, all text here is ignored (comment type #1) */ @@ -57,11 +62,12 @@ loadmodule "cloak_sha256"; /* Or load the old module from UnrealIRCd 3.2/4/5 instead: */ //loadmodule "cloak_md5"; +// CHANGE THIS (the 'name' and the 'info'): /* This is the me { } block which basically says who we are. * It defines our server name, some information line and an unique "sid". * The server id (sid) must start with a digit followed by two digits or * letters. The sid must be unique for your IRC network (each server should - * have it's own sid). + * have it's own sid). It is common to use 001 for the first server. */ me { name "irc.example.org"; @@ -69,6 +75,7 @@ me { sid "001"; } +// CHANGE THIS: /* The admin { } block defines what users will see if they type /ADMIN. * It normally contains information on how to contact the administrator. */ @@ -151,7 +158,7 @@ allow { */ /* Here is an example oper block for 'bobsmith' - * You MUST change this!! + * YOU MUST CHANGE THIS!! (the oper name and the password) */ oper bobsmith { class opers; @@ -452,16 +459,20 @@ blacklist efnetrbl { /* Network configuration */ set { + // CHANGE THIS, ALL 4 ITEMS: network-name "ExampleNET"; default-server "irc.example.org"; services-server "services.example.org"; stats-server "stats.example.org"; + + /* Normal defaults */ help-channel "#Help"; cloak-prefix "Clk"; prefix-quit "Quit"; /* Cloak keys should be the same at all servers on the network. * They are used for generating masked hosts and should be kept secret. + * YOU MUST CHANGE THIS! * The keys should be 3 random strings of 80 characters each (or more). * and must consist of lowcase (a-z), upcase (A-Z) and digits (0-9). * On *NIX, you can run './unrealircd gencloak' in your shell to let @@ -476,9 +487,10 @@ set { } /* Server specific configuration */ - set { + // FINALLY, YOU MUST CHANGE THIS NEXT ITEM: kline-address 'set.this.to.email.address'; /* e-mail or URL shown when a user is banned */ + modes-on-connect "+ixw"; /* when users connect, they will get these user modes */ modes-on-oper "+xws"; /* when someone becomes IRCOp they'll get these modes */ modes-on-join "+nt"; /* default channel modes when a new channel is created */