1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
|
ircd-ratbox INSTALL Document
$Id: INSTALL 27414 2012-12-31 21:34:15Z androsyn $
Copyright (c) 2001 by ircd-hybrid team
Copyright (c) 2002-2012 ircd-ratbox development team
----------------------------------------------------------------------
__ __ __ __
|__|.----.----.--| |___.----.---.-.| |_| |--.-----.--.--.
| || _| __| _ |___| _| _ || _| _ | _ |_ _|
|__||__| |____|_____| |__| |___._||____|_____|_____|__.__|
+--------------------------------------------------------------------+
| IMPORTANT: for those who don't bother reading docs... |
| If you are upgrading from ANY VERSION of ircd-ratbox, see the |
| instructions under UPGRADING, #3. YES, THIS MEANS YOU! |
` ------------------------------------------------------------------ '
Read the ChangeLog file to find out about the exciting
new features in this version. Other good reads are
doc/whats-new.txt, BUGS, doc/example.conf, and README.FIRST.
An example.conf for EFnet is in doc/ with the values "approved"
on 12 December 2001.
> QUICK START
1. Configure (see below under CONFIGURE OPTIONS for more details):
* IMPORTANT:
* At a minimum, you really ought to use the --prefix=/some/place option.
* By default, configure will select /usr/local/ircd -- YOU DO *NOT* WANT THAT!
* You may *NOT* run the ircd as root, and the ircd user needs to be able to write to
* it's own directories. You have been warned.
I. Large networks (with thousands of users):
./configure --prefix=/home/user/ircd
II. Small networks (with only a few hundred users or less):
./configure --prefix=/home/user/ircd --enable-small-net
III. Configure ircd-ratbox for running with minimal resources
on a 64bit VPS (Virtual Private Server). This creates
a 32bit IRCD which takes up less memory:
CFLAGS="-m32" ./configure --prefix=/home/user/ircd \
--enable-small-net
2. Build:
I. On linux systems: make
II. On *BSD systems: gmake
3. Install:
I. make install (or gmake install on *BSD)
II. make install-strip (strips out debugging code for smaller
binaries and modules)
DO NOT SUBMIT BUGS IF YOU HAVE STRIPPED THE IRCD OF DEBUGGING
SYMBOLS. WE WILL NOT BE ABLE TO HELP YOU.
> ADDITIONAL CONFIGURE OPTIONS
Note: There are some special optional parameters to the configure
script that some admins may wish to use.
* --enable-kqueue
Use the superior kqueue(2) system call as opposed to
the default poll(2). This is currently only available
on FreeBSD 4.1 or higher, and should be auto-detected.
* --enable-devpoll
Enable the superior /dev/poll support on Solaris.
Linux /dev/poll is broken and will not work with this
option. Do not use this unless you comprehend the implications.
* --enable-openssl
Enable the openssl dependent crypto functions.
This will allow CHALLENGE to work and encrypted links.
On systems where the configure script can automatically
detect OpenSSL, this option is not necessary.
If configure cannot find OpenSSL, you must specify a
path with this option.
(--enable-openssl=/path/to/openssl)
If you plan on using SSL encrypted client connections,
or encrypted links, you may wish to run
/path/to/ircd/bin/genssl.sh to generate self-signed
certificates.
* --enable-ipv6
Enable IPv6 support. This should be auto-detected.
* --enable-static
Enable a static-linked ircd. You will not be able to unload,
or reload modules. You probably don't want this.
* --enable-assert
Enable some of the debugging code. This should NOT be used
on production servers. Doing so is a performance hit,
and can cause cores from things that shouldn't normally happen.
* --enable-small-net
Tunes the server for smaller networks by reducing the
startup memory footprint. This should really only be used
for *small* networks, as this tends to be a performance hit
on larger networks.
* --with-nicklen
Sets the maximum NICK length. Note that this MUST be
consistant across your entire network.
* --enable-services
If your network runs ratbox-services, this enables extra
code to actually make it useful on your ircd.
Please read doc/services.txt for more information.
> UPGRADING
1. If this is a clean install of ircd-ratbox, you may skip this section.
2. Upgrading from ircd-ratbox-2.x, ircd-hybrid-7.x
If you have an older version of ircd-ratbox or ircd-hybrid, and
you have klines, dlines, resvs, and xline config files, keep
reading.
ircd-ratbox no longer uses flat-file based configs for these
types of entries, instead they are stored in a database. To
prevent accidental clobbering, or leaving behind old, unsupported
modules it would be best to install ratbox into a clean location.
After you have finished installing the ircd, you will likey wish
to import your old ban files. ircd-ratbox-3 includes a tool
to manage the database. Importing, backing up, error checking,
and reclaiming lost space are all supported. For more information,
run /path/to/ircd/bin/bantool with no arguments.
I. import old ban configs (pretend mode):
/path/to/ircd/bin/bantool -i -d -p /path/to/oldircd/etc
If everything looks good, you will want to actually let
bantool do the import.
II. import old ban configs:
/path/to/ircd/bin/bantool -i -d /path/to/oldircd/etc
3. Upgrading from another version ircd-ratbox-3.x
* IMPORTANT: EVERY TIME YOU UPGRADE ircd-ratbox-3 YOU NEED TO
ISSUE THIS COMMAND. FAILURE TO DO SO CAN CAUSE YOUR IRCD TO CORE!
I. /path/to/ircd/bin/bantool -u
> HOW TO GET HELP
Send Check or Money Order to... just kidding!
(However free beer is always appreciated)
* For Bug Reports, visit: http://bugs.ratbox.org
* For General Question, you may ask your question
on #ratbox on EFnet.
If you do fix anything, however, please post a context or unified
diff on http://bugs.ratbox.org so the fixes can be incorporated into
the next release of ircd-ratbox.
If ratbox crashes on you, please submit a bug report, and include the
gdb backtrace or corefile on http://bugs.ratbox.org
DISCUSSION: There is a low-volume mailing list for discussion of
ratbox issues, To subscribe, visit:
http://lists.ratbox.org/cgi-bin/mailman/listinfo/ircd-ratbox
----------------------------------------------------------------------
> NOTES
The best way to get a backtrace of the core is to follow this sequence of
instructions:
1. Change to the directory containing the core file
2. Run gdb on the binary and the core file. With an unmodified
ircd-ratbox installation, an example command line is below
(in the /path/to/ircd directory). This will be useless
if you used 'make install-strip'.
$ gdb bin/ircd ircd.core
3. At the "(gdb)" prompt, enter the command "bt"
4. Save the output of the backtrace command and submit it to
http://bugs.ratbox.org
5. Be sure to save the ircd binary, the modules, and the core file
in a safe place in case the developers need to look deeper
than a backtrace provides.
|
