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/trunk/INSTALL (file contents), Revision 8359 by michael, Sun Mar 4 14:19:23 2018 UTC

#	Line 2 | Line 2
2
3		$Id$
4
5	<	Copyright (c) 1997-2007 IRCD-Hybrid Development Team
5	>	Copyright (c) 1997-2018 ircd-hybrid development team
6
7		----------------------------------------------------------------------
8
#	Line 15 | Line 15
15		| - You now need to ./configure --prefix="/path/to/install/it" as a      |
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!  |
18		+------------------------------------------------------------------------+
19
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.
26	–	**********************
27	–
20		----------------------------------------------------------------------
21
22		HOW TO BUILD
#	Line 32 | Line 24
24		As of hybrid-4, the distribution uses GNU autoconf instead of the old
25		Config script. You must run ./configure before you can (sanely) build
26		ircd-hybrid.
35	–
36	–	1.  Read the NEWS file to find out about the exciting new features in
37	–	this version. Other good reads are BUGS, etc/example.conf, and
38	–	README.FIRST.
27
28	<	An example.conf for EFnet is in etc/ with the values "approved" as of
29	<	October 12th, 2003 called example.efnet.conf.
28	>	1.  Read the NEWS file to find out about the exciting new features in
29	>	this version. Other good reads are doc/reference.conf, and README.
30
31		2.  Run the configure script. It will create config.h and the
32	<	Makefiles to match your system. In hybrid-7, the paths are now handled
32	>	Makefiles to match your system. The paths are now handled
33		with the --prefix option to configure.
34		/usr/local/ircd is the default if no prefix is specified.
35
36		./configure --prefix=/usr/local/ircd
37
38	<	The script will determine whichever of the following is best for
39	<	your system, but you may (unsupported) force their usage with
38	>	The script will determine whichever of the following is best for
39	>	your system, but you may (unsupported) force their usage with
40		undefined results:
41
42		* --enable-kqueue - Use the superior kqueue(2) system call as
43	<	opposed to the default poll(2).  This is currently only available
44	<	on FreeBSD 4.1 or higher.
43	>	opposed to the default poll(2). This is currently only available
44	>	on FreeBSD, OpenBSD, NetBSD, and Mac OS X
45
46		* --enable-devpoll - Enable the superior /dev/poll support on
47	<	Solaris.  Linux /dev/poll is broken and will not work with this
47	>	Solaris. Linux /dev/poll is broken and will not work with this
48		option.
49
50	<	* --enable-epoll - Enables epoll(4) Signal I/O system.  This is
50	>	* --enable-epoll - Enables epoll(4) Signal I/O system. This is
51		currently only available on 2.5.44 Linux kernel versions or
52		later.
53
54	<	* --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
67	<	system.  This is currently only available on 2.4 Linux kernel
68	<	versions or later.
69	<
70	<	* --enable-poll - Use POSIX poll(2).
71	<
72	<	* --enable-select - Use POSIX select(2).
73	<
74	<	Incidentally, the order of listing above is the order of auto-
75	<	detection in configure.  So if you do have kqueue but wish to
76	<	enable select(2) instead (bad idea), you must use --enable-select.
77	<
78	<	* --enable-openssl - Enable the openssl dependent crypto functions.
79	<	This will allow CHALLENGE to work and encrypted links. On systems
80	<	where the configure script can automatically detect OpenSSL, this
81	<	option is not necessary.  If configure cannot find OpenSSL, you
82	<	must specify a path with this option
83	<	(--enable-openssl=/path/to/openssl)
84	<
85	<	These are optional or have default values that may be overridden:
86	<
87	<	* --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
93	<	should not be used on any production servers for maximum speed
94	<	so as to prevent cores from things that shouldn't normally happen.
95	<
96	<	* --enable-halfops - Enable halfops (%, mode +h) usage. Halfops
97	<	are similar to plain ops, but can't kick/deop plain ops. Halfops
98	<	may or may not kick/deop other halfops depending on if (+p) is
99	<	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.
113	<
114	<	* --with-nicklen,
115	<	--with-topiclen - Respectively, sets the maximum NICK length and
116	<	maximum TOPIC length. Note that this must be consistent across your
117	<	entire network. Defaults are 9 and 120, respectively.
118	<
119	<	* --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.
126	<
127	<	3.  Run 'make'; this should build the ircd.
128	<
129	<	4.  Run 'make install'; this will install the server, modules(1), and tools
130	<	in the path with the prefix specified when configure was ran.
54	>	* --enable-poll - Use POSIX poll(2).
55
56	<	(1) Unless the server was compiled without module support.
56	>	Incidentally, the order of listing above is the order of auto-
57	>	detection in configure. So if you do have kqueue but wish to
58	>	enable poll(2) instead (bad idea), you must use --enable-poll.
59	>
60	>	* --enable-openssl - Enable the LibreSSL/OpenSSL dependent crypto functions.
61	>	Required for the SSL Challenge controlled OPER feature, compressed
62	>	and/or SSL/TLS server links, as well as SSL/TLS client connections.
63	>
64	>	On systems where the configure script can automatically detect
65	>	LibreSSL or OpenSSL, this option is not necessary. If configure cannot
66	>	find LibreSSL or OpenSSL, you must specify a path with this option
67	>	(--enable-openssl=/path/to/openssl)
68
134	–	5.  If you wish to install the contrib modules, run 'make install' in the
135	–	contrib/ folder to compile and install the modules and help pages.
69
70	<	6.  If you wish to enable the user log, oper log, and failed oper log,
138	<	kill log, kline log and the gline log issue these commands at the
139	<	shell prompt (in the prefix directory).
70	>	These are optional or have default values that may be overridden:
71
72	<	$ touch logs/userlog
73	<	$ touch logs/operlog
74	<	$ touch logs/foperlog
75	<	$ touch logs/kill
76	<	$ touch logs/kline
77	<	$ touch logs/gline
72	>	* --enable-assert - Enable use of numerous debugging checks. This is
73	>	considered a developer-only feature and should not be used on any
74	>	production servers for maximum speed so as to prevent cores from
75	>	things that shouldn't normally happen.
76	>
77	>	* --enable-debugging - Prepares Makefiles to compile the ircd sources
78	>	with proper settings that are required for debugging purposes.
79	>	This switch basically sets CFLAGS to "-g -O0".
80
81	<	Note: If you use different names in ircd.conf, you must 'touch'
82	<	their specific names.
81	>	* --disable-mempool - Disables the memory pooling allocator and makes
82	>	code fall back straight to malloc/free. Useful for debugging purposes.
83
84	<	7.  If you are upgrading from Hybrid 5 or Hybrid 6, the config files
85	<	have changed drastically...
84	>	* --enable-efence - Allows easy linking with the electric fence memory
85	>	debugger library.
86
154	–	By default, the kline file is named kline.conf, the dline file is
155	–	named dline.conf, the xline file is called xline.conf, and the gline
156	–	file is called gline.conf.
87
88	<	The nick resv file is named nresv.conf, channel resv file is named
159	<	cresv.conf.
88	>	3.  Run 'make'; this should build the ircd.
89
90	<	The oper motd file is named opers.motd.
90	>	4.  Run 'make install'; this will install the server, modules, and tools
91	>	in the path with the prefix specified when configure was ran.
92
93		----------------------------------------------------------------------
94
95		HOW TO GET HELP
96
97	<	- Send Check or Money Order to... just kidding! You're on your own for
98	<	support. Try asking other ircd-hybrid admins on EFnet if you can't
99	<	fix it yourself. If you do fix anything, however, please send context
100	<	or unified diffs to bugs@ircd-hybrid.org so the fixes can be
101	<	incorporated into the next release of ircd-hybrid. If hybrid crashes
102	<	on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
103	<	the core. The Hybrid team can't fix bugs if no one tells us about them!
104	<
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	<
179	<	- https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
180	<	Here you can subscribe to a mailing list for general discussion of Hybrid.
97	>	- Send Check or Money Order to... just kidding! For bugs, patches or crash
98	>	reports, contact bugs@ircd-hybrid.org. Please provide as much information
99	>	as possible, context or unified diffs or backtrace of the core.
100	>	The Hybrid team can't fix bugs if no one tells us about them!
101	>
102	>	- For general discussion or support, you can subscribe to our mailing list at
103	>	https://lists.ircd-hybrid.org/mailman/listinfo/hybrid. Alternatively,
104	>	you can find us on IRC in #ircd-coders on irc.ircd-hybrid.org.
105
106		----------------------------------------------------------------------
107
#	Line 188 | Line 112
112
113		1.  Change to the directory containing the core file
114
115	<	2.  Run gdb on the binary and the core file. With an unmodified Hybrid-7.2
115	>	2.  Run gdb on the binary and the core file. With an unmodified ircd-hybrid
116		installation, an example command line is below (in the /usr/local/ircd
117		directory)
118

Comparing:
ircd-hybrid-7.2/INSTALL (property svn:keywords), Revision 920 by michael, Thu Nov 8 07:46:34 2007 UTC vs.
ircd-hybrid/trunk/INSTALL (property svn:keywords), Revision 8359 by michael, Sun Mar 4 14:19:23 2018 UTC

#	Line 1 | Line 1
1	<	Id Revision
1	>	Id

Diff Legend

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