ViewVC Help

View File | Revision Log | Show Annotations | View Changeset | Root Listing

root/svn/ircd-hybrid/releases/8.1.0beta4/doc/reference.conf

Comparing ircd-hybrid/trunk/doc/reference.conf (file contents):
Revision 1825 by michael, Sun Apr 14 19:54:48 2013 UTC vs.
Revision 1866 by michael, Thu Apr 25 17:44:05 2013 UTC

#	Line 47 | Line 47 | serverinfo {
47		* sid: a server's unique ID.  This is three characters long and must
48		* be in the form [0-9][A-Z0-9][A-Z0-9].  The first character must be
49		* a digit, followed by 2 alpha-numerical letters.
50	<	* NOTE: The letters must be capitalized.  This cannot be changed at runtime.
50	>	* NOTE: The letters must be capitalized. This cannot be changed at runtime.
51		*/
52		sid = "0HY";
53
#	Line 58 | Line 58 | serverinfo {
58
59		/*
60		* network info: the name and description of the network this server
61	<	* is on.  Shown in the 005 reply and used with serverhiding.
61	>	* is on. Shown in the 005 reply and used with serverhiding.
62		*/
63		network_name = "MyNet";
64		network_desc = "This is My Network";
#	Line 81 | Line 81 | serverinfo {
81		*/
82		#vhost6 = "3ffe:80e8:546::2";
83
84	<	/* max_clients: the maximum number of clients allowed to connect */
84	>	/* max_clients: the maximum number of clients allowed to connect. */
85		max_clients = 512;
86
87		/*
#	Line 117 | Line 117 | serverinfo {
117		* ssl certificate for encrypted client connection.
118		*
119		* This assumes your private RSA key is stored in rsa.key. You
120	<	* MUST have an RSA key in order to generate the certificate
120	>	* MUST have an RSA key in order to generate the certificate.
121	>	*
122	>	* Example command:
123		*
124		*      openssl req -new -days 365 -x509 -key rsa.key -out cert.pem
125		*
#	Line 192 | Line 194 | admin {
194		* class {}:  contains information about classes for users
195		*/
196		class {
197	<	/* name: the name of the class */
197	>	/* name: the name of the class. */
198		name = "users";
199
200		/*
#	Line 225 | Line 227 | class {
227
228		/*
229		* the following lines are optional and allow you to define
230	<	* how many users can connect from one /NN subnet
230	>	* how many users can connect from one /NN subnet.
231		*/
232		cidr_bitlen_ipv4 = 24;
233		cidr_bitlen_ipv6 = 120;
#	Line 253 | Line 255 | class {
255		sendq = 100 kbytes;
256
257		/*
258	<	* min_idle: minimum idle time that is shown in /whois
258	>	* min_idle: minimum idle time that is shown in /whois.
259		*/
260		min_idle = 3 hours;
261
262		/*
263	<	* max_idle: maximum idle time that is shown in /whois
263	>	* max_idle: maximum idle time that is shown in /whois.
264		*/
265		max_idle = 8 hours;
266
#	Line 277 | Line 279 | class {
279		ping_time = 90 seconds;
280
281		/*
282	<	* connectfreq: only used in server classes.  Specifies the delay
282	>	* connectfreq: only used in server classes. Specifies the delay
283		* between autoconnecting to servers.
284		*/
285		connectfreq = 5 minutes;
286
287	<	/* max number: the amount of servers to autoconnect to */
287	>	/* max number: the amount of servers to autoconnect to. */
288		max_number = 1;
289
290	<	/* sendq: servers need a higher sendq as they send more data */
290	>	/* sendq: servers need a higher sendq as they send more data. */
291		sendq = 2 megabytes;
292		};
293
#	Line 294 | Line 296 | class {
296		*/
297		listen {
298		/*
299	<	* port: the specific port to listen on.  If no host is specified
299	>	* port: the specific port to listen on. If no host is specified
300		* before, it will listen on all available IPs.
301		*
302		* Ports are separated via a comma, a range may be specified using ".."
#	Line 307 | Line 309 | listen {
309		* Listen on 192.168.0.1/6697 with ssl enabled and hidden from STATS P
310		* unless you are an administrator.
311		*
312	<	* NOTE: The "flags" directive has to come before "port".  Always!
312	>	* NOTE: The "flags" directive has to come before "port". Always!
313		*
314		* Currently available flags are:
315		*
#	Line 321 | Line 323 | listen {
323
324		/*
325		* host: set a specific IP/host the ports after the line will listen
326	<	* on.  This may be ipv4 or ipv6.
326	>	* on. This may be ipv4 or ipv6.
327		*/
328		host = "1.2.3.4";
329		port = 7000, 7001;
#	Line 351 | Line 353 | auth {
353		encrypted = yes;
354
355		/*
356	<	* spoof: fake the users host to this.  This is free-form,
357	<	* just do everyone a favor and don't abuse it. ('=' prefix on /stats I)
356	>	* spoof: fake the users host to this. This is free-form, just do
357	>	* everyone a favor and don't abuse it. ('=' prefix on /stats I)
358		*/
359		spoof = "I.still.hate.packets";
360
#	Line 371 | Line 373 | auth {
373		* resv_exempt   - exempt this user from resvs ('$' prefix on /stats I)
374		* no_tilde      - remove ~ from a user with no ident ('-' prefix on /stats I)
375		* can_flood     - allow this user to exceed flood limits ('|' prefix on /stats I)
376	<	* webirc        - enables WEBIRC authentication for web-based clients such as Mibbit
376	>	* webirc        - enables WEBIRC authentication for web-based clients such as Mibbit
377		*                 ('<' prefix on /stats I)
378		*/
379		flags = need_password, spoof_notice, exceed_limit, kline_exempt,
#	Line 380 | Line 382 | auth {
382
383		auth {
384		/*
385	<	* redirect: the server and port to redirect a user to.  A user does
386	<	* not have to obey the redirection, the ircd just suggests an alternative
385	>	* redirect: the server and port to redirect a user to. A user does not
386	>	* have to obey the redirection, the ircd just suggests an alternative
387		* server for them.
388		*/
389		redirserv = "this.is.not.a.real.server";
#	Line 401 | Line 403 | auth {
403
404		/*
405		* operator {}:  defines ircd operators
404	–	*
405	–	* ircd-hybrid no longer supports local operators, privileges are
406	–	* controlled via flags.
406		*/
407		operator {
408		/* name: the name of the oper */
#	Line 417 | Line 416 | operator {
416		user = "*@127.0.0.0/8";
417
418		/*
419	<	* password: the password required to oper.  By default this will
419	>	* password: the password required to oper. By default this will
420		* need to be encrypted by using the provided mkpasswd tool.
421		* Several password hash algorithms are available depending
422		* on your system's crypt() implementation. For example, a modern
#	Line 443 | Line 442 | operator {
442		class = "opers";
443
444		/*
445	<	* umodes: default usermodes opers get when they /oper.  If defined,
445	>	* umodes: default usermodes opers get when they /oper. If defined,
446		* it will override oper_umodes settings in general {}.
447		* Available usermodes:
448		*
#	Line 463 | Line 462 | operator {
462		* +k - skill        - See server generated KILL messages
463		* +l - locops       - See LOCOPS messages
464		* +n - nchange      - See client nick changes
465	+	* +R - nononreg     - Only receive private messages from registered clients
466		* +s - servnotice   - See general server notices
467		* +u - unauth       - See unauthorized client notices
468		* +w - wallop       - See server generated WALLOPS
#	Line 519 | Line 519 | connect {
519		name = "irc.uplink.com";
520
521		/*
522	<	* host: the host or IP to connect to.  If a hostname is used it
522	>	* host: the host or IP to connect to. If a hostname is used it
523		* must match the reverse dns of the server.
524		*/
525		host = "192.168.0.1";
#	Line 548 | Line 548 | connect {
548		port = 6666;
549
550		/*
551	<	* hub_mask: the mask of servers that this server may hub.  Multiple
552	<	* entries are permitted
551	>	* hub_mask: the mask of servers that this server may hub. Multiple
552	>	* entries are permitted.
553		*/
554		hub_mask = "*";
555
556		/*
557	<	* leaf_mask: the mask of servers this server may not hub.  Multiple
558	<	* entries are permitted.  Useful for forbidding EU -> US -> EU routes.
557	>	* leaf_mask: the mask of servers this server may not hub. Multiple
558	>	* entries are permitted. Useful for forbidding EU -> US -> EU routes.
559		*/
560		#       leaf_mask = "*.uk";
561
#	Line 638 | Line 638 | cluster {
638		*
639		* NOTE: This can be effectively used for remote klines.
640		*       Please note that there is no password authentication
641	<	*       for users setting remote klines.  You must also be
641	>	*       for users setting remote klines. You must also be
642		*       /oper'd in order to issue a remote kline.
643		*/
644		shared {
645		/*
646	<	* name: the server the user must be on to set klines.  If this is not
646	>	* name: the server the user must be on to set klines. If this is not
647		* specified, the user will be allowed to kline from all servers.
648		*/
649		name = "irc2.some.server";
650
651		/*
652	<	* user: the user@host mask that is allowed to set klines.  If this is
652	>	* user: the user@host mask that is allowed to set klines. If this is
653		* not specified, all users on the server above will be allowed to set
654		* a remote kline.
655		*/
#	Line 700 | Line 700 | deny {
700		};
701
702		/*
703	<	* exempt {}: IPs that are exempt from deny {} and Dlines
703	>	* exempt {}:  IPs that are exempt from deny {} and Dlines
704		*/
705		exempt {
706		ip = "192.168.0.0/16";
#	Line 709 | Line 709 | exempt {
709		/*
710		* resv {}:  nicks and channels users may not use/join
711		*/
712	<	resv { nick = "clone*"; reason = "Clone bots"; };
713	<	resv { nick = "NickServ"; reason = "Reserved for services"; };
714	<	resv { nick = "OperServ"; reason = "Reserved for services"; };
715	<	resv { nick = "MemoServ"; reason = "Reserved for services"; };
716	<	resv { nick = "BotServ"; reason = "Reserved for services"; };
717	<	resv { nick = "HelpServ"; reason = "Reserved for services"; };
718	<	resv { nick = "HostServ"; reason = "Reserved for services"; };
719	<	resv { nick = "StatServ"; reason = "Reserved for services"; };
720	<	resv { channel = "#*services*"; reason = "Reserved for services"; };
712	>	resv { mask = "clone*"; reason = "Clone bots"; };
713	>	resv { mask = "ChanServ"; reason = "Reserved for services"; };
714	>	resv { mask = "NickServ"; reason = "Reserved for services"; };
715	>	resv { mask = "OperServ"; reason = "Reserved for services"; };
716	>	resv { mask = "MemoServ"; reason = "Reserved for services"; };
717	>	resv { mask = "BotServ"; reason = "Reserved for services"; };
718	>	resv { mask = "HelpServ"; reason = "Reserved for services"; };
719	>	resv { mask = "HostServ"; reason = "Reserved for services"; };
720	>	resv { mask = "StatServ"; reason = "Reserved for services"; };
721	>	resv { mask = "#*services*"; reason = "Reserved for services"; };
722	>
723	>	resv {
724	>	/*
725	>	* mask: masks starting with a '#' are automatically considered
726	>	* as channel name mask.
727	>	*/
728	>	mask = "#helsinki";
729	>	reason = "Channel is reserved for finnish inhabitants";
730	>
731	>	/*
732	>	* exempt: can be either a ISO 3166 alpha-2 two letter country
733	>	* code, or a nick!user@host mask. CIDR is supported. Exempt
734	>	* entries can be stacked.
735	>	*/
736	>	exempt = "FI";
737	>	};
738
739		/*
740	<	* gecos {}:  The X: replacement, used for banning users based on
724	<	* their "realname".
740	>	* gecos {}:  Used for banning users based on their "realname".
741		*/
742		gecos {
743		name = "*sex*";
#	Line 763 | Line 779 | channel {
779		disable_fake_channels = yes;
780
781		/*
766	–	* restrict_channels: reverse channel RESVs logic, only reserved
767	–	* channels are allowed
768	–	*/
769	–	restrict_channels = no;
770	–
771	–	/*
782		* knock_delay: The amount of time a user must wait between issuing
783		* the knock command.
784		*/
#	Line 816 | Line 826 | channel {
826
827		/*
828		* default_split_user_count: when the usercount is lower than this level,
829	<	* consider ourselves split.  This must be set for automatic splitmode.
829	>	* consider ourselves split. This must be set for automatic splitmode.
830		*/
831		default_split_user_count = 0;
832
833		/*
834		* default_split_server_count: when the servercount is lower than this,
835	<	* consider ourselves split.  This must be set for automatic splitmode.
835	>	* consider ourselves split. This must be set for automatic splitmode.
836		*/
837		default_split_server_count = 0;
838
#	Line 840 | Line 850 | channel {
850		serverhide {
851		/*
852		* flatten_links: this option will show all servers in /links appear
853	<	* that they are linked to this current server
853	>	* that they are linked to this current server.
854		*/
855		flatten_links = no;
856
#	Line 852 | Line 862 | serverhide {
862
863		/*
864		* hidden: hide this server from a /links output on servers that
865	<	* support it.  This allows hub servers to be hidden etc.
865	>	* support it. This allows hub servers to be hidden etc.
866		*/
867		hidden = no;
868
#	Line 863 | Line 873 | serverhide {
873		hide_servers = no;
874
875		/*
876	+	* hide_services: define this if you want to hide the location of
877	+	* services servers that are specified in the service{} block.
878	+	*/
879	+	hide_services = no;
880	+
881	+	/*
882		* Use this as the servername users see if hide_servers = yes.
883		*/
884		hidden_name = "*.hidden.com";
#	Line 893 | Line 909 | general {
909		/* max_watch: maximum WATCH entries a client can have. */
910		max_watch = 60;
911
912	<	/* gline_enable: enable glines, network wide temp klines */
912	>	/* gline_enable: enable glines, network wide temp klines. */
913		gline_enable = yes;
914
915		/*
916		* gline_duration: the amount of time a gline will remain on your
917	<	* server before expiring
917	>	* server before expiring.
918		*/
919		gline_duration = 1 day;
920
921		/*
922	<	* gline_request_duration:  how long a pending G-line can be around.
923	<	* 10 minutes should be plenty
922	>	* gline_request_duration: how long a pending G-line can be around.
923	>	* 10 minutes should be plenty.
924		*/
925		gline_request_duration = 10 minutes;
926
927		/*
928		* gline_min_cidr: the minimum required length of a CIDR bitmask
929	<	* for IPv4 based glines
929	>	* for IPv4 based glines.
930		*/
931		gline_min_cidr = 16;
932
933		/*
934		* gline_min_cidr6: the minimum required length of a CIDR bitmask
935	<	* for IPv6 based glines
935	>	* for IPv6 based glines.
936		*/
937		gline_min_cidr6 = 48;
938
#	Line 926 | Line 942 | general {
942		invisible_on_connect = yes;
943
944		/*
945	<	* Max time from the nickname change that still causes KILL
946	<	* automatically to switch for the current nick of that user.
945	>	* kill_chase_time_limit: maximum time from the nickname change that
946	>	* still causes KILL automatically to switch for the current nick of
947	>	* that user.
948		*/
949		kill_chase_time_limit = 90 seconds;
950
951		/*
952	<	* If hide_spoof_ips is disabled, opers will be allowed to see the real
952	>	* hide_spoof_ips: if disabled, opers will be allowed to see the real
953		* IP of spoofed users in /trace etc. If this is defined they will be
954		* shown a masked IP.
955		*/
956		hide_spoof_ips = yes;
957
958		/*
959	<	* Ignore bogus timestamps from other servers.  Yes, this will desync
960	<	* the network, but it will allow chanops to resync with a valid non TS 0
959	>	* Ignore bogus timestamps from other servers. Yes, this will desync the
960	>	* network, but it will allow chanops to resync with a valid non TS 0
961		*
962		* This should be enabled network wide, or not at all.
963		*/
#	Line 952 | Line 969 | general {
969		*/
970		disable_auth = no;
971
972	<	/* disable_remote_commands: disable users doing commands on remote servers */
972	>	/* disable_remote_commands: disable users doing commands on remote servers. */
973		disable_remote_commands = no;
974
975		/*
#	Line 963 | Line 980 | general {
980
981		/*
982		* default_floodcount: the default value of floodcount that is configurable
983	<	* via /quote set floodcount.  This is the amount of lines a user
983	>	* via /quote set floodcount. This is the amount of lines a user
984		* may send to any other user/channel in one second.
985		*/
986		default_floodcount = 10;
#	Line 982 | Line 999 | general {
999
1000		/*
1001		* min_nonwildcard: the minimum non wildcard characters in k/d/g lines
1002	<	* placed via the server.  klines hand placed are exempt from limits.
1002	>	* placed via the server. K-lines hand placed are exempt from limits.
1003		* wildcard chars: '.' ':' '*' '?' '@' '!' '#'
1004		*/
1005		min_nonwildcard = 4;
1006
1007		/*
1008		* min_nonwildcard_simple: the minimum non wildcard characters in
1009	<	* gecos bans.  wildcard chars: '*' '?' '#'
1009	>	* gecos bans. wildcard chars: '*' '?' '#'
1010		*/
1011		min_nonwildcard_simple = 3;
1012
1013	<	/* max_accept: maximum allowed /accept's for +g usermode */
1013	>	/* max_accept: maximum allowed /accept's for +g usermode. */
1014		max_accept = 20;
1015
1016	<	/* anti_nick_flood: enable the nickflood control code */
1016	>	/* anti_nick_flood: enable the nickflood control code. */
1017		anti_nick_flood = yes;
1018
1019		/* nick flood: the nick changes allowed in the specified period */
#	Line 1011 | Line 1028 | general {
1028
1029		/*
1030		* ts delta: the time delta allowed between server clocks before
1031	<	* a warning is given, or before the link is dropped.  all servers
1031	>	* a warning is given, or before the link is dropped. All servers
1032		* should run ntpdate/rdate to keep clocks in sync
1033		*/
1034		ts_warn_delta = 30 seconds;
#	Line 1019 | Line 1036 | general {
1036
1037		/*
1038		* warn_no_nline: warn opers about servers that try to connect but
1039	<	* we don't have a connect {} block for.  Twits with misconfigured
1039	>	* we don't have a connect {} block for. Twits with misconfigured
1040		* servers can get really annoying with this enabled.
1041		*/
1042		warn_no_nline = yes;
1043
1044		/*
1045		* stats_e_disabled: set this to 'yes' to disable "STATS e" for both
1046	<	* operators and administrators.  Doing so is a good idea in case
1046	>	* operators and administrators. Doing so is a good idea in case
1047		* there are any exempted (exempt{}) server IPs you don't want to
1048		* see leaked.
1049		*/
#	Line 1039 | Line 1056 | general {
1056		stats_P_oper_only = yes;
1057
1058		/*
1059	<	* stats i oper only: make stats i (auth {}) oper only. set to:
1060	<	*     yes:    show users no auth blocks, made oper only.
1061	<	*     masked: show users first matching auth block
1062	<	*     no:     show users all auth blocks.
1059	>	* stats i oper only: make stats i (auth {}) oper only. Set to:
1060	>	*     yes    - show users no auth blocks, made oper only.
1061	>	*     masked - show users first matching auth block
1062	>	*     no     - show users all auth blocks.
1063		*/
1064		stats_i_oper_only = yes;
1065
1066		/*
1067	<	* stats_k_oper_only: make stats k/K (klines) oper only.  set to:
1068	<	*     yes:    show users no auth blocks, made oper only
1069	<	*     masked: show users first matching auth block
1070	<	*     no:     show users all auth blocks.
1067	>	* stats_k_oper_only: make stats k/K (klines) oper only. Set to:
1068	>	*     yes    - show users no auth blocks, made oper only
1069	>	*     masked - show users first matching auth block
1070	>	*     no     - show users all auth blocks.
1071		*/
1072		stats_k_oper_only = yes;
1073
#	Line 1095 | Line 1112 | general {
1112
1113		/*
1114		* true_no_oper_flood: completely eliminate flood limits for opers
1115	<	* and for clients with can_flood = yes in their auth {} blocks
1115	>	* and for clients with can_flood = yes in their auth {} blocks.
1116		*/
1117		true_no_oper_flood = yes;
1118
1119	<	/* oper_pass_resv: allow opers to over-ride RESVs on nicks/channels */
1119	>	/* oper_pass_resv: allow opers to over-ride RESVs on nicks/channels. */
1120		oper_pass_resv = yes;
1121
1122		/* REMOVE ME.  The following line checks you've been reading. */
#	Line 1107 | Line 1124 | general {
1124
1125		/*
1126		* max_targets: the maximum amount of targets in a single
1127	<	* PRIVMSG/NOTICE.  Set to 999 NOT 0 for unlimited.
1127	>	* PRIVMSG/NOTICE. Set to 999 NOT 0 for unlimited.
1128		*/
1129		max_targets = 4;
1130
1131		/*
1115	–	* message_locale: the default message locale
1116	–	* Use "standard" for the compiled in defaults.
1117	–	* To install the translated messages, go into messages/ in the
1118	–	* source directory and run `make install'.
1119	–	*/
1120	–	message_locale = "standard";
1121	–
1122	–	/*
1132		* usermodes configurable: a list of usermodes for the options below
1133		*
1134		* +b - bots         - See bot and drone flooding notices
#	Line 1138 | Line 1147 | general {
1147		* +k - skill        - See server generated KILL messages
1148		* +l - locops       - See LOCOPS messages
1149		* +n - nchange      - See client nick changes
1150	+	* +R - nononreg     - Only receive private messages from registered clients
1151		* +s - servnotice   - See general server notices
1152		* +u - unauth       - See unauthorized client notices
1153		* +w - wallop       - See server generated WALLOPS
#	Line 1155 | Line 1165 | general {
1165
1166		/*
1167		* use_egd: if your system does not have *random devices yet you
1168	<	* want to use OpenSSL and encrypted links, enable this.  Beware -
1169	<	* EGD is *very* CPU intensive when gathering data for its pool
1168	>	* want to use OpenSSL and encrypted links, enable this. Beware -
1169	>	* EGD is *very* CPU intensive when gathering data for its pool.
1170		*/
1171		#       use_egd = yes;
1172
#	Line 1168 | Line 1178 | general {
1178
1179		/*
1180		* throttle_time: the minimum amount of time between connections from
1181	<	* the same ip.  exempt {} blocks are excluded from this throttling.
1182	<	* Offers protection against flooders who reconnect quickly.
1181	>	* the same ip. exempt {} blocks are excluded from this throttling.
1182	>	* Offers protection against flooders who reconnect quickly.
1183		* Set to 0 to disable.
1184		*/
1185		throttle_time = 10;
#	Line 1183 | Line 1193 | modules {
1193		path = "/usr/local/ircd/lib/ircd-hybrid/modules";
1194		path = "/usr/local/ircd/lib/ircd-hybrid/modules/autoload";
1195
1196	<	/* module: the name of a module to load on startup/rehash */
1196	>	/* module: the name of a module to load on startup/rehash. */
1197		#module = "some_module.la";
1198		};
1199

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines (old)
>	Changed lines (new)