ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/ircd-hybrid-8/INSTALL
Revision: 1156
Committed: Tue Aug 9 20:29:20 2011 UTC (12 years, 7 months ago) by michael
File size: 8134 byte(s)
Log Message:
- create ircd-hybrid-8 "branch"

File Contents

# Content
1 Hybrid INSTALL Document
2
3 $Id$
4
5 Copyright (c) 1997-2011 IRCD-Hybrid Development Team
6
7 ----------------------------------------------------------------------
8
9 +------------------------------------------------------------------------+
10 | Note for those who don't bother reading docs: |
11 | |
12 | Reading INSTALL is now a must, as the old DPATH is now specified when |
13 | configure is run. |
14 | |
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! |
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.
26 **********************
27
28 ----------------------------------------------------------------------
29
30 HOW TO BUILD
31
32 As of hybrid-4, the distribution uses GNU autoconf instead of the old
33 Config script. You must run ./configure before you can (sanely) build
34 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.
39
40 2. Run the configure script. It will create config.h and the
41 Makefiles to match your system. In hybrid-7, the paths are now handled
42 with the --prefix option to configure.
43 /usr/local/ircd is the default if no prefix is specified.
44
45 ./configure --prefix=/usr/local/ircd
46
47 The script will determine whichever of the following is best for
48 your system, but you may (unsupported) force their usage with
49 undefined results:
50
51 * --enable-kqueue - Use the superior kqueue(2) system call as
52 opposed to the default poll(2). This is currently only available
53 on FreeBSD 4.1 or higher.
54
55 * --enable-devpoll - Enable the superior /dev/poll support on
56 Solaris. Linux /dev/poll is broken and will not work with this
57 option.
58
59 * --enable-epoll - Enables epoll(4) Signal I/O system. This is
60 currently only available on 2.5.44 Linux kernel versions or
61 later.
62
63 * --enable-rtsigio - Enable the superior Linux RealTime Signal I/O
64 system. This is currently only available on 2.4 Linux kernel
65 versions or later.
66
67 * --enable-poll - Use POSIX poll(2).
68
69 * --enable-select - Use POSIX select(2).
70
71 Incidentally, the order of listing above is the order of auto-
72 detection in configure. So if you do have kqueue but wish to
73 enable select(2) instead (bad idea), you must use --enable-select.
74
75 * --enable-openssl - Enable the openssl dependent crypto functions.
76 This will allow CHALLENGE to work and encrypted links. On systems
77 where the configure script can automatically detect OpenSSL, this
78 option is not necessary. If configure cannot find OpenSSL, you
79 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 * --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.
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).
93
94 * --enable-small-net - Tunes the server for smaller networks by
95 reducing the startup memory footprint. This should really only be
96 used for *small* networks, as this tends to be a performance hit
97 on larger networks.
98
99 * --enable-syslog=kill/squit/connect/users/oper, separated by
100 spaces, in quotes - Enables syslog logging, with events you specify
101 (none is okay too, and logs the most essential messages only.)
102
103 * --enable-syslog-facility=FACILITY - Check with your sysadmin to see
104 what this should be; by default it is LOG_LOCAL4. If you get it wrong
105 initially, no problem; just edit the value in include/setup.h.
106
107 * --with-nicklen,
108 --with-topiclen - Respectively, sets the maximum NICK length and
109 maximum TOPIC length. Note that this must be consistent across your
110 entire network. Defaults are 9 and 120, respectively.
111
112 * --disable-zlib - Build the ircd without ziplinks support.
113
114
115 3. Run 'make'; this should build the ircd.
116
117 4. Run 'make install'; this will install the server, modules, and tools
118 in the path with the prefix specified when configure was ran.
119
120 5. If you wish to install the contrib modules, run 'make install' in the
121 contrib/ folder to compile and install the modules and help pages.
122
123 6. If you wish to enable the user log, oper log, and failed oper log,
124 kill log, kline log and the gline log issue these commands at the
125 shell prompt (in the prefix directory).
126
127 $ touch logs/userlog
128 $ touch logs/operlog
129 $ touch logs/foperlog
130 $ touch logs/kill
131 $ touch logs/kline
132 $ touch logs/gline
133
134 Note: If you use different names in ircd.conf, you must 'touch'
135 their specific names.
136
137 7. If you are upgrading from Hybrid 5 or Hybrid 6, the config files
138 have changed drastically.
139
140 By default, the kline file is named kline.conf, the dline file is
141 named dline.conf, and the xline file is called xline.conf.
142
143 The nick resv file is named nresv.conf, channel resv file is named
144 cresv.conf.
145
146 The oper motd file is named opers.motd.
147
148 ----------------------------------------------------------------------
149
150 HOW TO GET HELP
151
152 - Send Check or Money Order to... just kidding! You're on your own for
153 support. Try asking other ircd-hybrid admins on EFnet if you can't
154 fix it yourself. If you do fix anything, however, please send context
155 or unified diffs to bugs@ircd-hybrid.org so the fixes can be
156 incorporated into the next release of ircd-hybrid. If hybrid crashes
157 on you, PLEASE contact bugs@ircd-hybrid.org ASAP with a backtrace of
158 the core. The Hybrid team can't fix bugs if no one tells us about them!
159
160 - https://lists.ircd-hybrid.org/mailman/listinfo/hybrid
161 Here you can subscribe to a mailing list for general discussion of Hybrid.
162
163 ----------------------------------------------------------------------
164
165 NOTES
166
167 The best way to get a backtrace of the core is to follow this sequence of
168 instructions:
169
170 1. Change to the directory containing the core file
171
172 2. Run gdb on the binary and the core file. With an unmodified ircd-hybrid
173 installation, an example command line is below (in the /usr/local/ircd
174 directory)
175
176 $ gdb bin/ircd ircd.core
177
178
179 3. At the "(gdb)" prompt, enter the command "bt full"
180
181 4. Save the output of the backtrace command and send it to
182 bugs@ircd-hybrid.org.
183
184 5. Be sure to save the ircd binary, the modules, and the core file in a
185 safe place in case the developers need to look deeper than a backtrace
186 provides.

Properties

Name Value
svn:eol-style native
svn:keywords Id Revision