ViewVC Help

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

root/svn/ircd-hybrid/trunk/INSTALL

Comparing:
ircd-hybrid-7.2/INSTALL (file contents), Revision 920 by michael, Thu Nov 8 07:46:34 2007 UTC vs.
ircd-hybrid-8/INSTALL (file contents), Revision 1548 by michael, Mon Oct 1 16:37:20 2012 UTC

#	Line 2 | Line 2
2
3		$Id$
4
5	<	Copyright (c) 1997-2007 IRCD-Hybrid Development Team
5	>	Copyright (c) 1997-2012 IRCD-Hybrid Development Team
6
7		----------------------------------------------------------------------
8
#	Line 16 | Line 16
16		|   minimum. Try ./configure --help or read this file for more info on   |
17		|   the possible options you can pass to configure.                      |
18		|                                                                        |
19	<	| - Important: The old config format WILL NOT WORK. Please see point 7!  |
19	>	| - Important: The old config format WILL NOT WORK. Please see point 6!  |
20		+------------------------------------------------------------------------+
21
22		***** EFNET NOTE *****
23	<	You should run ./configure with the option '--enable-efnet' to tweak
24	<	some options to be EFNet based.  You must also use the example.efnet.conf
25	<	instead of example.conf.
23	>	You should use the example.efnet.conf instead of example.conf.
24		**********************
25
26		----------------------------------------------------------------------
#	Line 34 | Line 32
32		ircd-hybrid.
33
34		1.  Read the NEWS file to find out about the exciting new features in
35	<	this version. Other good reads are BUGS, etc/example.conf, and
36	<	README.FIRST.
39	<
40	<	An example.conf for EFnet is in etc/ with the values "approved" as of
41	<	October 12th, 2003 called example.efnet.conf.
35	>	this version. Other good reads are BUGS, doc/example.conf, and
36	>	README.
37
38		2.  Run the configure script. It will create config.h and the
39	<	Makefiles to match your system. In hybrid-7, the paths are now handled
39	>	Makefiles to match your system. The paths are now handled
40		with the --prefix option to configure.
41		/usr/local/ircd is the default if no prefix is specified.
42
#	Line 52 | Line 47
47		undefined results:
48
49		* --enable-kqueue - Use the superior kqueue(2) system call as
50	<	opposed to the default poll(2).  This is currently only available
50	>	opposed to the default poll(2). This is currently only available
51		on FreeBSD 4.1 or higher.
52
53		* --enable-devpoll - Enable the superior /dev/poll support on
54	<	Solaris.  Linux /dev/poll is broken and will not work with this
54	>	Solaris. Linux /dev/poll is broken and will not work with this
55		option.
56
57	<	* --enable-epoll - Enables epoll(4) Signal I/O system.  This is
57	>	* --enable-epoll - Enables epoll(4) Signal I/O system. This is
58		currently only available on 2.5.44 Linux kernel versions or
59		later.
60
61		* --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
62	<	system.  This is currently only available on 2.4 Linux kernel
62	>	system. This is currently only available on 2.4 Linux kernel
63		versions or later.
64
65	<	* --enable-poll - Use POSIX poll(2).
65	>	* --enable-poll - Use POSIX poll(2).
66
67	<	* --enable-select - Use POSIX select(2).
67	>	* --enable-select - Use POSIX select(2).
68
69	<	Incidentally, the order of listing above is the order of auto-
70	<	detection in configure.  So if you do have kqueue but wish to
71	<	enable select(2) instead (bad idea), you must use --enable-select.
69	>	Incidentally, the order of listing above is the order of auto-
70	>	detection in configure. So if you do have kqueue but wish to
71	>	enable select(2) instead (bad idea), you must use --enable-select.
72
73		* --enable-openssl - Enable the openssl dependent crypto functions.
74	<	This will allow CHALLENGE to work and encrypted links. On systems
75	<	where the configure script can automatically detect OpenSSL, this
76	<	option is not necessary.  If configure cannot find OpenSSL, you
77	<	must specify a path with this option
74	>	Required for the SSL Challenge controlled OPER feature, compressed
75	>	and/or SSL/TLS server links, as well as SSL/TLS client connections.
76	>
77	>	On systems where the configure script can automatically detect
78	>	OpenSSL, this option is not necessary. If configure cannot find
79	>	OpenSSL, you must specify a path with this option
80		(--enable-openssl=/path/to/openssl)
81
82	+
83		These are optional or have default values that may be overridden:
84
85	<	* --disable-shared-modules - Disable module support.  This option is
88	<	more secure, but reduces a lot of the flexibility in hybrid-7.
89	<	This may need to be used on some systems without a working
90	<	dlopen/dlsym.
91	<
92	<	* --enable-assert - Enable use of numerous debugging checks.  This
85	>	* --enable-assert - Enable use of numerous debugging checks. This
86		should not be used on any production servers for maximum speed
87	<	so as to prevent cores from things that shouldn't normally happen.
87	>	so as to prevent cores from things that shouldn't normally happen.
88
89	<	* --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
90	<	are similar to plain ops, but can't kick/deop plain ops. Halfops
91	<	may or may not kick/deop other halfops depending on if (+p) is
92	<	set. Halfops may not set (+/-p).
100	<
101	<	* --enable-small-net - Tunes the server for smaller networks by
102	<	reducing the startup memory footprint. This should really only be
103	<	used for *small* networks, as this tends to be a performance hit
104	<	on larger networks.
105	<
106	<	* --enable-syslog=kill/squit/connect/users/oper, separated by
107	<	spaces, in quotes - Enables syslog logging, with events you specify
108	<	(none is okay too, and logs the most essential messages only.)
109	<
110	<	* --enable-syslog-facility=FACILITY - Check with your sysadmin to see
111	<	what this should be; by default it is LOG_LOCAL4. If you get it wrong
112	<	initially, no problem; just edit the value in include/setup.h.
89	>	* --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
90	>	are similar to plain ops, but can't kick/deop plain ops. Halfops
91	>	may or may not kick/deop other halfops depending on if (+p) is
92	>	set. Halfops may not set (+/-p).
93
94		* --with-nicklen,
95	<	--with-topiclen - Respectively, sets the maximum NICK length and
96	<	maximum TOPIC length. Note that this must be consistent across your
97	<	entire network. Defaults are 9 and 120, respectively.
98	<
99	<	* --disable-zlib - Build the ircd without ziplinks support.
120	<
121	<	* --disable-gline-voting - This is good for small networks or where
122	<	G-Line voting is not necessary. Please understand that by disabling
123	<	this, it will allow any operator with G-Line permissions to G-Line
124	<	someone without requiring the approval of 2 other operators. However,
125	<	it is useful if you use proxy scanners or services that do G-Lines.
95	>	--with-topiclen - Respectively, sets the maximum NICK length and
96	>	maximum TOPIC length. Note that this must be consistent across your
97	>	entire network. Defaults are 9 and 120, respectively.
98	>
99	>
100
101		3.  Run 'make'; this should build the ircd.
102
103	<	4.  Run 'make install'; this will install the server, modules(1), and tools
103	>	4.  Run 'make install'; this will install the server, modules, and tools
104		in the path with the prefix specified when configure was ran.
105
132	–	(1) Unless the server was compiled without module support.
133	–
106		5.  If you wish to install the contrib modules, run 'make install' in the
107		contrib/ folder to compile and install the modules and help pages.
108
109	<	6.  If you wish to enable the user log, oper log, and failed oper log,
110	<	kill log, kline log and the gline log issue these commands at the
139	<	shell prompt (in the prefix directory).
140	<
141	<	$ touch logs/userlog
142	<	$ touch logs/operlog
143	<	$ touch logs/foperlog
144	<	$ touch logs/kill
145	<	$ touch logs/kline
146	<	$ touch logs/gline
147	<
148	<	Note: If you use different names in ircd.conf, you must 'touch'
149	<	their specific names.
150	<
151	<	7.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
152	<	have changed drastically...
109	>	6.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
110	>	have changed drastically.
111
112		By default, the kline file is named kline.conf, the dline file is
113	<	named dline.conf, the xline file is called xline.conf, and the gline
156	<	file is called gline.conf.
113	>	named dline.conf, and the xline file is called xline.conf.
114
115		The nick resv file is named nresv.conf, channel resv file is named
116		cresv.conf.
117
161	–	The oper motd file is named opers.motd.
162	–
118		----------------------------------------------------------------------
119
120		HOW TO GET HELP
#	Line 172 | Line 127
127		on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
128		the core. The Hybrid team can't fix bugs if no one tells us about them!
129
175	–	- http://forum.ircd-hybrid.org/
176	–	We decided to create a phpBB-like forum about ircd-hybrid, where you
177	–	can get help from coders and admins, post your suggestions, modules etc.
178	–
130		- https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
131		Here you can subscribe to a mailing list for general discussion of Hybrid.
132
#	Line 188 | Line 139
139
140		1.  Change to the directory containing the core file
141
142	<	2.  Run gdb on the binary and the core file. With an unmodified Hybrid-7.2
142	>	2.  Run gdb on the binary and the core file. With an unmodified ircd-hybrid
143		installation, an example command line is below (in the /usr/local/ircd
144		directory)
145

Diff Legend

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