ViewVC Help

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

root/svn/ircd-hybrid/branches/8.2.x/doc/reference.conf

Comparing ircd-hybrid/trunk/doc/reference.conf (file contents):
Revision 2308 by michael, Wed Jun 19 19:43:39 2013 UTC vs.
Revision 2322 by michael, Sun Jun 23 12:01:30 2013 UTC

#	Line 8 | Line 8
8
9		/*
10		* ########################################################################
11	<	* IMPORTANT NOTES:
11	>	* IMPORTANT NOTE:
12		*
13		* auth {} blocks MUST be specified in order of precedence.  The first one
14		* that matches a user will be used.  So place spoofs first, then specials,
#	Line 76 | Line 76 | serverinfo {
76		#       vhost = "192.169.0.1";
77
78		/*
79	<	* vhost6: the IP to bind to when we connect outward to ipv6 servers.
80	<	* This should be an ipv6 IP only, or "*" for INADDR_ANY.
79	>	* vhost6: the address to bind to when we make outgoing connections
80	>	* to IPv6 servers. This should be an IPv6 address, or "*" for INADDR_ANY.
81		*/
82		#       vhost6 = "3ffe:80e8:546::2";
83
#	Line 98 | Line 98 | serverinfo {
98		max_topic_length = 160;
99
100		/*
101	<	* rsa_private_key_file: the path to the file containing our
102	<	* rsa key for cryptlink.
101	>	* rsa_private_key_file: the path to the file containing the
102	>	* RSA key for cryptlink.
103		*
104	<	* Example command to store a 2048 bit RSA keypair in
104	>	* Example commands to store a 2048 bit RSA keypair in
105		* rsa.key, and the public key in rsa.pub:
106		*
107		*      openssl genrsa -out rsa.key 2048
#	Line 114 | Line 114 | serverinfo {
114
115		/*
116		* ssl_certificate_file: the path to the file containing our
117	<	* ssl certificate for encrypted client connection.
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.
#	Line 138 | Line 138 | serverinfo {
138		* ssl_dh_param_file:
139		*
140		* Path to the PEM encoded Diffie-Hellman parameter file.
141	<	* DH parameters are strictly required when using ciphers
142	<	* with EDH (ephemeral Diffie-Hellman) key exchange.
141	>	* DH parameters are required when using ciphers with EDH
142	>	* (ephemeral Diffie-Hellman) key exchange.
143		*
144		* A DH parameter file can be created by running:
145		*
#	Line 154 | Line 154 | serverinfo {
154		/*
155		* ssl_cipher_list:
156		*
157	<	* List of ciphers that are supported by _this_ server. Can be used to
157	>	* List of ciphers to support on _this_ server. Can be used to
158		* enforce specific ciphers for incoming SSL/TLS connections.
159	<	* If a client (which also includes incoming server connections) isn't
160	<	* capable of any cipher listed below, the connection will simply be
161	<	* rejected.
159	>	* If a client (which also includes incoming server connections) is not
160	>	* capable of using any of the ciphers listed here, the connection will
161	>	* simply be rejected.
162		*
163	<	* A list of supported ciphers can be obtained by running:
163	>	* A list of supported ciphers by OpenSSL can be obtained by running:
164		*
165		*      openssl ciphers -ssl3 -tls1 -v
166		*
#	Line 205 | Line 205 | class {
205
206		/*
207		* number_per_ip: how many local users are allowed to connect
208	<	* from one IP  (optional)
208	>	* from a single IP address  (optional)
209		*/
210		number_per_ip = 2;
211
212		/*
213		* max_local: how many local users are allowed to connect
214	<	* from one ident@host  (optional)
214	>	* from a single ident@host  (optional)
215		*/
216		max_local = 2;
217
#	Line 234 | Line 234 | class {
234		number_per_cidr = 16;
235
236		/*
237	<	* sendq: the amount of data allowed in a clients send queue before
237	>	* sendq: the amount of data allowed in a client's send queue before
238		* they are dropped.
239		*/
240		sendq = 100 kbytes;
241
242		/*
243	<	* recvq: maximum amount of data in a clients receive queue before
243	>	* recvq: the amount of data allowed in a client's receive queue before
244		* they are dropped for flooding. Defaults to 2560 if the chosen
245		* value isn't within the range of 512 to 8000.
246		*/
#	Line 267 | Line 267 | class {
267		/*
268		* flags:
269		*
270	<	* random_idle          - idle time is randomly selected within the
271	<	*                        range of min_idle to max_idle
272	<	* hide_idle_from_opers - fake idle time will be shown to operators, too
270	>	* random_idle          - a fake idle time is set randomly between
271	>	*                        min_idle and max_idle
272	>	* hide_idle_from_opers - the fake idle time will also be shown to operators
273		*/
274		flags = random_idle, hide_idle_from_opers;
275		};
#	Line 284 | Line 284 | class {
284		*/
285		connectfreq = 5 minutes;
286
287	<	/* max number: the amount of servers to autoconnect to. */
287	>	/* max number: the number of servers to autoconnect to. */
288		max_number = 1;
289
290		/* sendq: servers need a higher sendq as they send more data. */
#	Line 292 | Line 292 | class {
292		};
293
294		/*
295	<	* motd {}: Allows to show a different MOTD to a client
295	>	* motd {}: Allows the display of a different MOTD to a client
296		* depending on its origin. Applies to local users only.
297		*/
298		motd {
#	Line 315 | Line 315 | motd {
315		*/
316		listen {
317		/*
318	<	* port: the specific port to listen on. If no host is specified
319	<	* before, it will listen on all available IPs.
318	>	* port: the port to listen on. If no host is specified
319	>	* earlier in the listen {} block, it will listen on all available IPs.
320		*
321	<	* Ports are separated via a comma, a range may be specified using ".."
321	>	* Ports are separated by commsa; a range may be specified using ".."
322		*/
323
324	<	/* port: listen on all available IPs, ports 6665 to 6669 */
324	>	/* port: listen on all available IP addresses, ports 6665 to 6669 */
325		port = 6665 .. 6669;
326
327		/*
328	<	* Listen on 192.168.0.1/6697 with ssl enabled and hidden from STATS P
328	>	* Listen on 192.168.0.1/6697 with SSL enabled and hidden from STATS P
329		* unless you are an administrator.
330		*
331	<	* NOTE: The "flags" directive has to come before "port". Always!
331	>	* NOTE: The "flags" directive always has to come before "port".
332		*
333		* Currently available flags are:
334		*
#	Line 341 | Line 341 | listen {
341		port = 6697;
342
343		/*
344	<	* host: set a specific IP/host the ports after the line will listen
345	<	* on. This may be ipv4 or ipv6.
344	>	* host: set a specific IP address/host to listen on using the
345	>	* subsequent port definitions. This may be IPv4 or IPv6.
346		*/
347		host = "1.2.3.4";
348		port = 7000, 7001;
#	Line 357 | Line 357 | listen {
357		auth {
358		/*
359		* user: the user@host allowed to connect. Multiple user
360	<	* lines are permitted per auth block.
360	>	* lines are permitted within each auth block.
361		*/
362		user = "*@172.16.0.0/12";
363		user = "*test@123D:B567:*";
#	Line 372 | Line 372 | auth {
372		encrypted = yes;
373
374		/*
375	<	* spoof: fake the users host to this. This is free-form, just do
375	>	* spoof: fake the user's host to this. This is free-form, just do
376		* everyone a favor and don't abuse it. ('=' prefix on /stats I)
377		*/
378		spoof = "I.still.hate.packets";
#	Line 402 | Line 402 | auth {
402		auth {
403		/*
404		* redirect: the server and port to redirect a user to. A user does not
405	<	* have to obey the redirection, the ircd just suggests an alternative
405	>	* have to obey the redirection; the ircd just suggests an alternative
406		* server for them.
407		*/
408		redirserv = "this.is.not.a.real.server";
#	Line 439 | Line 439 | operator {
439		* need to be encrypted by using the provided mkpasswd tool.
440		* Several password hash algorithms are available depending
441		* on your system's crypt() implementation. For example, a modern
442	<	* glibc already has support for SHA-256/512, and MD5 encryption
442	>	* glibc already has support for the SHA-256/512 and MD5 encryption
443		* algorithms.
444		*/
445		password = "$5$x5zof8qe.Yc7/bPp$5zIg1Le2Lsgd4CvOjaD20pr5PmcfD7ha/9b2.TaUyG4";
#	Line 452 | Line 452 | operator {
452
453		/*
454		* rsa_public_key_file: the public key for this oper when using Challenge.
455	<	* A password should not be defined when this is used, see
455	>	* A password should not be defined when this is used; see
456		* doc/challenge.txt for more information.
457		*/
458		#       rsa_public_key_file = "/usr/local/ircd/etc/oper.pub";
#	Line 480 | Line 480 | operator {
480		class = "opers";
481
482		/*
483	<	* umodes: default usermodes opers get when they /oper. If defined,
483	>	* umodes: the default usermodes opers get when they /oper. If defined,
484		* it will override oper_umodes settings in general {}.
485		* Available usermodes:
486		*
#	Line 542 | Line 542 | operator {
542		};
543
544		/*
545	<	* service {}: specifies what server may act as a network service
545	>	* service {}: specifies a server which may act as a network service
546		*
547	<	* NOTE: it is absolutely important that every single server on the network
547	>	* NOTE: it is very important that every server on the network
548		*       has the same service{} block.
549		*/
550		service {
#	Line 553 | Line 553 | service {
553		};
554
555		/*
556	<	* connect {}:  controls servers we connect to
556	>	* connect {}: define a server to connect to
557		*/
558		connect {
559		/* name: the name of the server */
560		name = "irc.uplink.com";
561
562		/*
563	<	* host: the host or IP to connect to. If a hostname is used it
564	<	* must match the reverse dns of the server.
563	>	* host: the host or IP address to connect to. If a hostname is used it
564	>	* must match the reverse DNS of the server.
565		*/
566		host = "192.168.0.1";
567
568		/*
569	<	* vhost: the IP to bind to when we connect outward to servers.
569	>	* vhost: the IP address to bind to when making outgoing connections to
570	>	* servers.
571		* serverinfo::vhost and serverinfo::vhost6 will be overridden
572		* by this directive.
573		*/
574		vhost = "192.168.0.2";
575
576		/*
577	<	* passwords: the passwords we send (OLD C:) and accept (OLD N:).
578	<	* The remote server will have these passwords reversed.
577	>	* passwords: the passwords to send (OLD C:) and accept (OLD N:).
578	>	* The remote server will have these passwords swapped.
579		*/
580		send_password = "password";
581		accept_password = "anotherpassword";
#	Line 607 | Line 608 | connect {
608		* ssl_cipher_list:
609		*
610		* List of ciphers that the server we are connecting to must support.
611	<	* If the server isn't capable of any cipher listed below, the
612	<	* connection will simply be rejected.
611	>	* If the server is not capable of using any of the ciphers listed below,
612	>	* the connection will simply be rejected.
613		* Can be used to enforce stronger ciphers, even though this option
614		* is not necessarily required to establish a SSL/TLS connection.
615		*
#	Line 653 | Line 654 | connect {
654		*/
655		cluster {
656		/*
657	<	* name: the server to share with, this can take wildcards
657	>	* name: the server to share with; this can take wildcards
658		*
659	<	* NOTE: only local actions will be clustered, meaning if
659	>	* NOTE: only local actions will be clustered, meaning that if
660		*       the server receives a shared kline/unkline/etc, it
661		*       will not be propagated to clustered servers.
662		*
#	Line 666 | Line 667 | cluster {
667		name = "*.arpa";
668
669		/*
670	<	* type: list of what to share, options are as follows:
670	>	* type: list of what to share; options are as follows:
671		*      dline   - share dlines
672		*      undline - share undlines
673		*      kline   - share klines
#	Line 684 | Line 685 | cluster {
685		/*
686		* shared {}: users that are allowed to remote kline
687		*
688	<	* NOTE: This can be effectively used for remote klines.
688	>	* NOTE: This can effectively be used for remote klines.
689		*       Please note that there is no password authentication
690		*       for users setting remote klines. You must also be
691		*       /oper'd in order to issue a remote kline.
692		*/
693		shared {
694		/*
695	<	* name: the server the user must be on to set klines. If this is not
696	<	* specified, the user will be allowed to kline from all servers.
695	>	* name: the server the user must be connected to in order to set klines.
696	>	* If this is not specified, the user will be allowed to kline from all
697	>	* servers.
698		*/
699		name = "irc2.some.server";
700
#	Line 729 | Line 731 | kill {
731		};
732
733		/*
734	<	* deny {}:  IPs that are not allowed to connect (before DNS/ident lookup)
734	>	* deny {}:  IP addresses that are not allowed to connect
735	>	* (before DNS/ident lookup)
736		* Oper issued dlines will be added to the specified dline config
737		*/
738		deny {
#	Line 738 | Line 741 | deny {
741		};
742
743		/*
744	<	* exempt {}:  IPs that are exempt from deny {} and Dlines
744	>	* exempt {}:  IP addresses that are exempt from deny {} and Dlines
745		*/
746		exempt {
747		ip = "192.168.0.0/16";
#	Line 761 | Line 764 | resv { mask = "#*services*"; reason = "R
764		resv {
765		/*
766		* mask: masks starting with a '#' are automatically considered
767	<	* as channel name mask.
767	>	* as channel name masks.
768		*/
769		mask = "#helsinki";
770		reason = "Channel is reserved for finnish inhabitants";
#	Line 793 | Line 796 | gecos {
796		channel {
797		/*
798		* disable_fake_channels: this option, if set to 'yes', will
799	<	* disallow clients to create or join channels that have one
799	>	* disallow clients from creating or joining channels that have one
800		* of the following ASCII characters in their name:
801		*
802		*   2 | bold
#	Line 834 | Line 837 | channel {
837		max_bans = 100;
838
839		/*
840	<	* how many joins in how many seconds constitute a flood, use 0 to
840	>	* how many joins in how many seconds constitute a flood. Use 0 to
841		* disable. +b opers will be notified (changeable via /set)
842		*/
843		join_flood_count = 16;
844		join_flood_time = 8 seconds;
845
846		/*
847	<	* splitcode: The ircd will now check splitmode every few seconds.
847	>	* The ircd will now check splitmode (whether a server is split from
848	>	* the network) every few seconds; this functionality is known as
849	>	* splitcode and is influenced by the options below.
850		*
851		* Either split users or split servers can activate splitmode, but
852		* both conditions must be met for the ircd to deactivate splitmode.
#	Line 861 | Line 866 | channel {
866		*/
867		default_split_server_count = 0;
868
869	<	/* no_create_on_split: disallow users creating channels on split. */
869	>	/* no_create_on_split: do not allow users to create channels on split. */
870		no_create_on_split = yes;
871
872	<	/* no_join_on_split: disallow users joining channels at all on a split. */
872	>	/* no_join_on_split: do not allow users to join channels on a split. */
873		no_join_on_split = no;
874		};
875
876		/*
877		* serverhide {}:  The serverhide block contains the options regarding
878	<	* serverhiding
878	>	* to server hiding
879		*/
880		serverhide {
881		/*
882	<	* disable_remote_commands: disable users doing commands
882	>	* disable_remote_commands: disable users issuing commands
883		* on remote servers.
884		*/
885		disable_remote_commands = no;
886
887		/*
888		* flatten_links: this option will show all servers in /links appear
889	<	* that they are linked to this current server.
889	>	* as though they are linked to this current server.
890		*/
891		flatten_links = no;
892
#	Line 916 | Line 921 | serverhide {
921
922		/*
923		* hide_server_ips: If this is disabled, opers will be unable to see
924	<	* servers ips and will be shown a masked ip, admins will be shown the
925	<	* real ip.
924	>	* servers' IP addresses and will be shown a masked IP address; admins
925	>	* will be shown the real IP address.
926		*
927	<	* If this is enabled, nobody can see a servers ip. *This is a kludge*,
928	<	* it has the side effect of hiding the ips everywhere, including
929	<	* logfiles.
927	>	* If this is enabled, nobody can see a server's IP address.
928	>	* *This is a kludge*: it has the side effect of hiding the IP addresses
929	>	* everywhere, including logfiles.
930		*
931		* We recommend you leave this disabled, and just take care with who you
932		* give administrator privileges to.
#	Line 946 | Line 951 | general {
951		/* max_watch: maximum WATCH entries a client can have. */
952		max_watch = 60;
953
954	<	/* gline_enable: enable glines, network wide temp klines. */
954	>	/* gline_enable: enable glines (network-wide temporary klines). */
955		gline_enable = yes;
956
957		/*
#	Line 979 | Line 984 | general {
984		invisible_on_connect = yes;
985
986		/*
987	<	* kill_chase_time_limit: maximum time from the nickname change that
988	<	* still causes KILL automatically to switch for the current nick of
989	<	* that user.
987	>	* kill_chase_time_limit: KILL chasing is a feature whereby a KILL
988	>	* issued for a user who has recently changed nickname will be applied
989	>	* automatically to the new nick. kill_chase_time_limit is the maximum
990	>	* time following a nickname change that this chasing will apply.
991		*/
992		kill_chase_time_limit = 90 seconds;
993
994		/*
995		* hide_spoof_ips: if disabled, opers will be allowed to see the real
996	<	* IP of spoofed users in /trace etc. If this is defined they will be
997	<	* shown a masked IP.
996	>	* IP address of spoofed users in /trace etc. If this is defined they
997	>	* will be shown a masked IP.
998		*/
999		hide_spoof_ips = yes;
1000
#	Line 1014 | Line 1020 | general {
1020
1021		/*
1022		* default_floodcount: the default value of floodcount that is configurable
1023	<	* via /quote set floodcount. This is the amount of lines a user
1023	>	* via /quote set floodcount. This is the number of lines a user
1024		* may send to any other user/channel in one second.
1025		*/
1026		default_floodcount = 10;
#	Line 1026 | Line 1032 | general {
1032		failed_oper_notice = yes;
1033
1034		/*
1035	<	* dots_in_ident: the amount of '.' characters permitted in an ident
1035	>	* dots_in_ident: the number of '.' characters permitted in an ident
1036		* reply before the user is rejected.
1037		*/
1038		dots_in_ident = 2;
1039
1040		/*
1041	<	* min_nonwildcard: the minimum non wildcard characters in k/d/g lines
1042	<	* placed via the server. K-lines hand placed are exempt from limits.
1041	>	* min_nonwildcard: the minimum number of non-wildcard characters in
1042	>	* k/d/g lines placed via the server. K-lines hand-placed are exempt from
1043	>	* this limit.
1044		* Wildcard chars: '.', ':', '*', '?', '@', '!'
1045		*/
1046		min_nonwildcard = 4;
1047
1048		/*
1049	<	* min_nonwildcard_simple: the minimum non wildcard characters in
1050	<	* gecos bans. Wildcard chars: '*', '?'
1049	>	* min_nonwildcard_simple: the minimum number of non-wildcard characters
1050	>	* in gecos bans. Wildcard chars: '*', '?'
1051		*/
1052		min_nonwildcard_simple = 3;
1053
#	Line 1050 | Line 1057 | general {
1057		/* anti_nick_flood: enable the nickflood control code. */
1058		anti_nick_flood = yes;
1059
1060	<	/* nick flood: the nick changes allowed in the specified period */
1060	>	/* nick flood: the number of nick changes allowed in the specified period */
1061		max_nick_time = 20 seconds;
1062		max_nick_changes = 5;
1063
#	Line 1070 | Line 1077 | general {
1077
1078		/*
1079		* warn_no_nline: warn opers about servers that try to connect but
1080	<	* we don't have a connect {} block for. Twits with misconfigured
1081	<	* servers can get really annoying with this enabled.
1080	>	* for which we don't have a connect {} block. Twits with misconfigured
1081	>	* servers can become really annoying with this enabled.
1082		*/
1083		warn_no_nline = yes;
1084
#	Line 1095 | Line 1102 | general {
1102		/*
1103		* stats i oper only: make stats i (auth {}) oper only. Set to:
1104		*     yes    - show users no auth blocks, made oper only.
1105	<	*     masked - show users first matching auth block
1105	>	*     masked - show users the first matching auth block
1106		*     no     - show users all auth blocks.
1107		*/
1108		stats_i_oper_only = yes;
#	Line 1103 | Line 1110 | general {
1110		/*
1111		* stats_k_oper_only: make stats k/K (klines) oper only. Set to:
1112		*     yes    - show users no auth blocks, made oper only
1113	<	*     masked - show users first matching auth block
1113	>	*     masked - show users the first matching auth block
1114		*     no     - show users all auth blocks.
1115		*/
1116		stats_k_oper_only = yes;
#	Line 1121 | Line 1128 | general {
1128		opers_bypass_callerid = no;
1129
1130		/*
1131	<	* pace_wait_simple: time between use of less intensive commands
1131	>	* pace_wait_simple: minimum time required between use of less
1132	>	* intensive commands
1133		* (ADMIN, HELP, (L)USERS, VERSION, remote WHOIS)
1134		*/
1135		pace_wait_simple = 1 second;
1136
1137		/*
1138	<	* pace_wait: time between more intensive commands
1138	>	* pace_wait: minimum time required between use of more intensive commands
1139		* (AWAY, INFO, LINKS, MAP, MOTD, STATS, WHO, wildcard WHOIS, WHOWAS)
1140		*/
1141		pace_wait = 10 seconds;
1142
1143		/*
1144	<	* short_motd: send clients a notice telling them to read the motd
1145	<	* instead of forcing a motd to clients who may simply ignore it.
1144	>	* short_motd: send clients a notice telling them to read the MOTD
1145	>	* instead of forcing an MOTD to clients who may simply ignore it.
1146		*/
1147		short_motd = no;
1148
#	Line 1156 | Line 1164 | general {
1164		/* oper_pass_resv: allow opers to over-ride RESVs on nicks/channels. */
1165		oper_pass_resv = yes;
1166
1167	<	/* REMOVE ME.  The following line checks you've been reading. */
1167	>	/* REMOVE ME.  The following line checks that you have been reading. */
1168		havent_read_conf = 1;
1169
1170		/*
1171	<	* max_targets: the maximum amount of targets in a single
1171	>	* max_targets: the maximum number of targets in a single
1172		* PRIVMSG/NOTICE. Set to 999 NOT 0 for unlimited.
1173		*/
1174		max_targets = 4;
#	Line 1214 | Line 1222 | general {
1222		#       egdpool_path = "/var/run/egd-pool";
1223
1224		/*
1225	<	* throttle_time: the minimum amount of time between connections from
1226	<	* the same ip. exempt {} blocks are excluded from this throttling.
1225	>	* throttle_time: the minimum amount of time required between
1226	>	* connections from the same IP address. exempt {} blocks are excluded
1227	>	* from this throttling.
1228		* Offers protection against flooders who reconnect quickly.
1229		* Set to 0 to disable.
1230		*/

Diff Legend

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