ViewVC Help

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

root/svn/ircd-hybrid/trunk/doc/reference.conf

Comparing:
ircd-hybrid-8/etc/example.conf (file contents), Revision 1294 by michael, Wed Feb 22 20:48:30 2012 UTC vs.
ircd-hybrid-8/doc/example.conf (file contents), Revision 1534 by michael, Sun Sep 23 13:17:14 2012 UTC

#	Line 1 | Line 1
1	<	/* doc/example.conf - ircd-hybrid-7 Example configuration file
2	<	* Copyright (C) 2000-2011 Hybrid Development Team
1	>	/* doc/example.conf - ircd-hybrid-8 Example configuration file
2	>	* Copyright (C) 2000-2012 Hybrid Development Team
3		*
4		* Written by ejb, wcampbel, db, leeh and others
5		* Other example configurations can be found in the source dir under
6	<	* etc/.
6	>	* doc/.
7		*
8		* $Id$
9		*/
#	Line 39 | Line 39
39		*/
40
41		/*
42	<	* serverinfo {}:  contains information about the server. (OLD M:)
42	>	* serverinfo {}:  contains information about the server
43		*/
44		serverinfo {
45		/*
#	Line 56 | Line 56 | serverinfo {
56		sid = "_CHANGE_ME_";
57
58		/*
59	<	* description: the description of the server.  '[' and ']' may not
60	<	* be used here for compatibility with older servers.
59	>	* description: the description of the server.
60		*/
61	<	description = "hybrid-7 test server";
61	>	description = "ircd-hybrid test server";
62
63		/*
64		* network info: the name and description of the network this server
#	Line 125 | Line 124 | serverinfo {
124		#ssl_certificate_file = "/usr/local/ircd/etc/cert.pem";
125
126		/*
127	<	* ssl_server_protocol:
128	<	* SSL/TLS protocols we provide for incoming secure connections.
127	>	* ssl_dh_param_file:
128	>	*
129	>	* Path to the PEM encoded Diffie-Hellman parameter file.
130	>	* DH parameters are strictly required when using ciphers
131	>	* with EDH (ephemeral Diffie-Hellman) key exchange.
132	>	*
133	>	* A DH parameter file can be created by running:
134	>	*
135	>	*      openssl dhparam -out dhparam.pem 1024
136	>	*
137	>	* Prime size must be at least 1024 bits. Further information
138	>	* regarding specific OpenSSL dhparam command-line options
139	>	* can be found in the OpenSSL manual.
140	>	*/
141	>	#ssl_dh_param_file = "/usr/local/ircd/etc/dhparam.pem";
142	>
143	>	/*
144	>	* ssl_cipher_list:
145	>	*
146	>	* List of ciphers that are supported by _this_ server. Can be used to
147	>	* enforce specific ciphers for incoming SSL/TLS connections.
148	>	* If a client (which also includes incoming server connections) isn't
149	>	* capable of any cipher listed below, the connection will simply be
150	>	* rejected.
151	>	* A list of supported ciphers can be obtained by running:
152	>	*
153	>	*      openssl ciphers -ssl3 -tls1 -v
154	>	*
155	>	* Multiple ciphers are separated by colons. The order of preference is
156	>	* from left to right.
157	>	*/
158	>	#ssl_cipher_list = "DHE-RSA-AES256-SHA:AES256-SHA";
159	>
160	>	/*
161	>	* ssl_server_method:
162	>	* ssl_client_method:
163	>	*
164	>	* SSL/TLS methods we provide for incoming (server method) and
165	>	* outgoing (client method) SSL/TLS connections.
166		* This can be either sslv3 for SSLv3, and/or tlsv1 for TLSv1.
131	–	* SSLv2 is not suppported. This cannot be changed at runtime.
167		*/
168	<	#ssl_server_protocol = sslv3, tlsv1;
168	>	#ssl_server_method = tlsv1, sslv3;
169	>	#ssl_client_method = tlsv1;
170		};
171
172		/*
#	Line 146 | Line 182 | admin {
182		* class {}:  contains information about classes for users
183		*/
184		class {
185	<	/* name: the name of the class.  classes are text now */
185	>	/* name: the name of the class */
186		name = "users";
187
188		/*
#	Line 190 | Line 226 | class {
226		* they are dropped.
227		*/
228		sendq = 100 kbytes;
229	+
230	+	/*
231	+	* recvq: maximum amount of data in a clients queue before they
232	+	* are dropped for flooding. Defaults to 2560 if the chosen
233	+	* value isn't within the range of 512 to 8000.
234	+	*/
235	+	recvq = 2560 bytes;
236		};
237
238		class {
#	Line 197 | Line 240 | class {
240		ping_time = 90 seconds;
241		number_per_ip = 10;
242		max_number = 100;
243	<	sendq = 100kbytes;
243	>	sendq = 100 kbytes;
244		};
245
246		class {
#	Line 343 | Line 386 | operator {
386
387		/*
388		* user: the user@host required for this operator. Multiple
389	<	* user="" lines are supported.
389	>	* user="" lines are supported.
390		*/
391		user = "*god@192.168.0.0/16";
392		user = "*@127.0.0.0/8";
#	Line 384 | Line 427 | operator {
427		* +C - cconn_full   - Client connection/quit notices full
428		* +D - deaf         - Don't receive channel messages
429		* +d - debug        - See debugging notices
430	<	* +f - full         - See I: line full notices
430	>	* +f - full         - See auth{} block full notices
431		* +G - softcallerid - Server Side Ignore for users not on your channels
432		* +g - callerid     - Server Side Ignore (for privmsgs etc)
433		* +H - hidden       - Hides operator status to other users
#	Line 408 | Line 451 | operator {
451		* allowed to do on the server. All options default to no.
452		* Available options:
453		*
454	<	* module       - allows MODLIST, MODRESTART, MODLOAD, MODUNLOAD
454	>	* module       - allows MODULE
455		* global_kill  - allows remote users to be /KILL'd
456		* remote       - allows remote SQUIT and CONNECT
457		* remoteban    - allows remote KLINE/UNKLINE
458	<	* kline        - allows KILL, KLINE and DLINE
459	<	* unkline      - allows UNKLINE and UNDLINE
458	>	* dline        - allows DLINE
459	>	* undline      - allows UNDLINE
460	>	* kline        - allows KILL and KLINE
461	>	* unkline      - allows UNKLINE
462		* gline        - allows GLINE
463		* xline        - allows XLINE
464		* globops      - allows GLOBOPS
#	Line 422 | Line 467 | operator {
467		* rehash       - allows oper to REHASH config
468		* die          - allows DIE
469		* restart      - allows RESTART
470	+	* set          - allows SET
471		* admin        - gives admin privileges. admins for example,
472		*                may see the real IP addresses of servers.
473		*/
#	Line 431 | Line 477 | operator {
477
478		service {
479		name = "service.someserver";
480	<	name = "stats.someserver;
480	>	name = "stats.someserver";
481		};
482
483		/*
#	Line 486 | Line 532 | connect {
532		class = "server";
533
534		/*
535	<	* autoconn   - controls whether we autoconnect to this server or not,
536	<	*              dependent on class limits. By default, this is disabled.
537	<	* compressed - controls whether traffic is compressed via ziplinks.
538	<	*              By default, this is disabled
539	<	* cryptlink  - enable full encryption for all data passing between our
540	<	*              server and this link and rsa authentication.
541	<	* burst_away - This will send the /away string that users have set
542	<	*              on the server burst.  Note this can be a lot of data
543	<	*              and slow down your server burst.
544	<	* topicburst - Send topics to this server during channel burst.  Works
499	<	*              only if the server we are connecting to is capable
500	<	*              of TBURST/TB.
501	<	*/
502	<	#       flags = autoconn, compressed, cryptlink, burst_away, topicburst;
503	<	};
504	<
505	<	connect {
506	<	name = "encrypted.auth.example";
507	<	host = "some.host.somewhere";
508	<	port = 6667;
509	<
510	<	flags = cryptlink;
511	<
512	<	/*
513	<	* rsa_public_key_file: the path to the public keyfile of the server.
514	<	* Used instead of passwords.
535	>	* ssl_cipher_list:
536	>	*
537	>	* List of ciphers that the server we are connecting to must support.
538	>	* If the server isn't capable of any cipher listed below, the
539	>	* connection will simply be rejected.
540	>	* Can be used to enforce stronger ciphers, even though this option
541	>	* is not necessarily required to establish a SSL/TLS connection.
542	>	*
543	>	* Multiple ciphers are separated by colons. The order of preference
544	>	* is from left to right.
545		*/
546	<	rsa_public_key_file = "etc/remote.server.keyfile";
546	>	#ssl_cipher_list = "DHE-RSA-AES256-SHA:AES256-SHA";
547
548		/*
549	<	* cipher preference: set the preferred cipher for this link
550	<	*
551	<	* Available ciphers are:
522	<	*      BF/168 BF/128 CAST/128 IDEA/128 RC5.16/128
523	<	*      RC5.12/128 RC5.8/128 3DES/168 DES/56
524	<	*
525	<	* NOTE:  Some ciphers may not be supported by your OpenSSL.
526	<	*        Check the output from 'configure' for available ciphers.
527	<	*
528	<	* NOTE2: To help you decide what cipher to use, tools/encspeed
529	<	*        will show you approximately how fast each cipher is.
530	<	*        However, blowfish is fast and secure, and is probably
531	<	*        a good default for most situations.
532	<	*
533	<	* NOTE3: Default if none is set is BF/128
534	<	*
535	<	* The cipher *MUST* be the same in both directions.  If you
536	<	* set a cipher preference, your uplink must set the same cipher,
537	<	* else it will not link.
549	>	* autoconn   - controls whether we autoconnect to this server or not,
550	>	*              dependent on class limits. By default, this is disabled.
551	>	* ssl        - Initiates a TLS/SSL connection.
552		*/
553	<	#       cipher_preference = "BF/168";
553	>	#       flags = autoconn, ssl;
554		};
555
556		connect {
#	Line 574 | Line 588 | cluster {
588
589		/*
590		* type: list of what to share, options are as follows:
591	<	*      kline   - share klines
592	<	*      tkline  - share temporary klines
593	<	*      unkline - share unklines
594	<	*      xline   - share xlines
595	<	*      txline  - share temporary xlines
596	<	*      unxline - share unxlines
597	<	*      resv    - share resvs
598	<	*      tresv   - share temporary resvs
599	<	*      unresv  - share unresvs
600	<	*      locops  - share locops
587	<	*      all     - share all of the above (default)
591	>	*      dline   - share dlines
592	>	*      undline - share undlines
593	>	*      kline   - share klines
594	>	*      unkline - share unklines
595	>	*      xline   - share xlines
596	>	*      unxline - share unxlines
597	>	*      resv    - share resvs
598	>	*      unresv  - share unresvs
599	>	*      locops  - share locops
600	>	*      all     - share all of the above (default)
601		*/
602		type = kline, unkline, locops, xline, resv;
603		};
#	Line 613 | Line 626 | shared {
626
627		/*
628		* type: list of what to share, options are as follows:
629	<	*      kline   - allow oper/server to kline
630	<	*      tkline  - allow temporary klines
631	<	*      unkline - allow oper/server to unkline
632	<	*      xline   - allow oper/server to xline
633	<	*      txline  - allow temporary xlines
634	<	*      unxline - allow oper/server to unxline
635	<	*      resv    - allow oper/server to resv
636	<	*      tresv   - allow temporary resvs
624	<	*      unresv  - allow oper/server to unresv
629	>	*      dline   - allow oper/server to dline
630	>	*      undline - allow oper/server to undline
631	>	*      kline   - allow oper/server to kline
632	>	*      unkline - allow oper/server to unkline
633	>	*      xline   - allow oper/server to xline
634	>	*      unxline - allow oper/server to unxline
635	>	*      resv    - allow oper/server to resv
636	>	*      unresv  - allow oper/server to unresv
637		*      locops  - allow oper/server to locops - only used for servers that cluster
638	<	*      all     - allow oper/server to do all of the above (default)
638	>	*      all     - allow oper/server to do all of the above (default)
639		*/
640		type = kline, unkline, resv;
641		};
#	Line 673 | Line 685 | resv {
685		/* resv: the nicks and channels users may not join/use */
686		nick = "Global";
687		nick = "DevNull";
688	+	nick = "BotServ";
689		nick = "Services";
690		nick = "StatServ";
691	+	nick = "HelpServ";
692		nick = "HostServ";
693		nick = "NickServ";
694		nick = "ChanServ";
#	Line 729 | Line 743 | channel {
743		*   3 | mirc color
744		*  15 | plain text
745		*  22 | reverse
746	+	*  29 | italic
747		*  31 | underline
748		* 160 | non-breaking space
749		*/
#	Line 741 | Line 756 | channel {
756		restrict_channels = no;
757
758		/*
744	–	* disable_local_channels: prevent users from joining &channels.
745	–	*/
746	–	disable_local_channels = no;
747	–
748	–	/*
749	–	* use_invex: Enable/disable channel mode +I, a n!u@h list of masks
750	–	* that can join a +i channel without an invite.
751	–	*/
752	–	use_invex = yes;
753	–
754	–	/*
755	–	* use_except: Enable/disable channel mode +e, a n!u@h list of masks
756	–	* that can join a channel through a ban (+b).
757	–	*/
758	–	use_except = yes;
759	–
760	–	/*
761	–	* use_knock: Allows users to request an invite to a channel that
762	–	* is locked somehow (+ikl).  If the channel is +p or you are banned
763	–	* the knock will not be sent.
764	–	*/
765	–	use_knock = yes;
766	–
767	–	/*
759		* knock_delay: The amount of time a user must wait between issuing
760		* the knock command.
761		*/
#	Line 777 | Line 768 | channel {
768		knock_delay_channel = 1 minute;
769
770		/*
771	<	* burst_topicwho: enable sending of who set topic on topicburst
772	<	* default is yes
771	>	* max_chans_per_user: The maximum number of channels a user can
772	>	* join/be on.
773		*/
774	<	burst_topicwho = yes;
774	>	max_chans_per_user = 25;
775
776		/*
777	<	* max_chans_per_user: The maximum number of channels a user can
777	>	* max_chans_per_oper: The maximum number of channels an oper can
778		* join/be on.
779		*/
780	<	max_chans_per_user = 25;
780	>	max_chans_per_oper = 50;
781
782		/* quiet_on_ban: stop banned people talking in channels. */
783		quiet_on_ban = yes;
784
785		/* max_bans: maximum number of +b/e/I modes in a channel */
786	<	max_bans = 25;
786	>	max_bans = 100;
787
788		/*
789		* how many joins in how many seconds constitute a flood, use 0 to
#	Line 853 | Line 844 | serverhide {
844		hidden = no;
845
846		/*
856	–	* disable_hidden: prevent servers hiding themselves from a
857	–	* /links output.
858	–	*/
859	–	disable_hidden = no;
860	–
861	–	/*
847		* hide_servers: hide remote servernames everywhere and instead use
848		* hidden_name and network_desc.
849		*/
#	Line 895 | Line 880 | general {
880		/* max_watch: maximum WATCH entries a client can have. */
881		max_watch = 60;
882
883	+	/* gline_enable: enable glines, network wide temp klines */
884	+	gline_enable = yes;
885	+
886	+	/*
887	+	* gline_duration: the amount of time a gline will remain on your
888	+	* server before expiring
889	+	*/
890	+	gline_duration = 1 day;
891	+
892	+	/*
893	+	* gline_request_duration:  how long a pending G-line can be around.
894	+	* 10 minutes should be plenty
895	+	*/
896	+	gline_request_duration = 10 minutes;
897	+
898		/*
899		* gline_min_cidr: the minimum required length of a CIDR bitmask
900		* for IPv4 based glines
#	Line 1084 | Line 1084 | general {
1084
1085		/*
1086		* pace_wait: time between more intensive commands
1087	<	* (INFO, LINKS, LIST, MAP, MOTD, STATS, WHO, wildcard WHOIS, WHOWAS)
1087	>	* (AWAY, INFO, LINKS, MAP, MOTD, STATS, WHO, wildcard WHOIS, WHOWAS)
1088		*/
1089		pace_wait = 10 seconds;
1090
#	Line 1122 | Line 1122 | general {
1122		max_targets = 4;
1123
1124		/*
1125	–	* client_flood: maximum amount of data in a clients queue before
1126	–	* they are dropped for flooding.
1127	–	*/
1128	–	client_flood = 2560 bytes;
1129	–
1130	–	/*
1125		* message_locale: the default message locale
1126		* Use "standard" for the compiled in defaults.
1127		* To install the translated messages, go into messages/ in the
#	Line 1143 | Line 1137 | general {
1137		* +C - cconn_full   - Client connection/quit notices full
1138		* +D - deaf         - Don't receive channel messages
1139		* +d - debug        - See debugging notices
1140	<	* +f - full         - See I: line full notices
1140	>	* +f - full         - See auth{} block full notices
1141		* +G - softcallerid - Server Side Ignore for users not on your channels
1142		* +g - callerid     - Server Side Ignore (for privmsgs etc)
1143		* +H - hidden       - Hides operator status to other users
#	Line 1170 | Line 1164 | general {
1164		oper_umodes = bots, locops, servnotice, operwall, wallop;
1165
1166		/*
1173	–	* servlink_path: path to 'servlink' program used by ircd to handle
1174	–	* encrypted/compressed server <-> server links.
1175	–	*
1176	–	* only define if servlink is not in same directory as ircd itself.
1177	–	*/
1178	–	#servlink_path = "/usr/local/ircd/bin/servlink";
1179	–
1180	–	/*
1181	–	* default_cipher_preference: default cipher to use for cryptlink when none is
1182	–	* specified in connect block.
1183	–	*/
1184	–	#default_cipher_preference = "BF/168";
1185	–
1186	–	/*
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
#	Line 1196 | Line 1176 | general {
1176		*/
1177		#       egdpool_path = "/var/run/egd-pool";
1178
1199	–
1200	–	/*
1201	–	* compression_level: level of compression for compressed links between
1202	–	* servers.
1203	–	*
1204	–	* values are between: 1 (least compression, fastest)
1205	–	*                and: 9 (most compression, slowest).
1206	–	*/
1207	–	#       compression_level = 6;
1208	–
1179		/*
1180		* throttle_time: the minimum amount of time between connections from
1181		* the same ip.  exempt {} blocks are excluded from this throttling.
#	Line 1215 | Line 1185 | general {
1185		throttle_time = 10;
1186		};
1187
1218	–	glines {
1219	–	/* enable: enable glines, network wide temp klines */
1220	–	enable = yes;
1221	–
1222	–	/*
1223	–	* duration: the amount of time a gline will remain on your
1224	–	* server before expiring
1225	–	*/
1226	–	duration = 1 day;
1227	–
1228	–	/*
1229	–	* log: which types of rules you want to log when triggered
1230	–	* (choose reject or block)
1231	–	*/
1232	–	log = reject, block;
1233	–
1234	–	/*
1235	–	* NOTE: gline ACLs can cause a desync of glines throughout the
1236	–	* network, meaning some servers may have a gline triggered, and
1237	–	* others may not. Also, you only need insert rules for glines
1238	–	* that you want to block and/or reject. If you want to accept and
1239	–	* propagate the gline, do NOT put a rule for it.
1240	–	*/
1241	–
1242	–	/* user@host for rule to apply to */
1243	–	user = "god@I.still.hate.packets";
1244	–	/* server for rule to apply to */
1245	–	name = "hades.arpa";
1246	–
1247	–	/*
1248	–	* action: action to take when a matching gline is found. options are:
1249	–	*  reject      - do not apply the gline locally
1250	–	*  block       - do not propagate the gline
1251	–	*/
1252	–	action = reject, block;
1253	–
1254	–	user = "god@*";
1255	–	name = "*";
1256	–	action = block;
1257	–	};
1258	–
1188		modules {
1189		/*
1190		* path: other paths to search for modules specified below
1191	<	* and in /modload.
1191	>	* and in "/module load".
1192		*/
1193		path = "/usr/local/ircd/lib/ircd-hybrid/modules";
1194		path = "/usr/local/ircd/lib/ircd-hybrid/modules/autoload";
#	Line 1274 | Line 1203 | modules {
1203		log {
1204		/* Do you want to enable logging to ircd.log? */
1205		use_logging = yes;
1277	–	timestamp = yes;
1206
1207		file {
1208		type = oper;

Diff Legend

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