1 |
ircd-hybrid-6 INSTALL |
2 |
--------------------- |
3 |
$Id$ |
4 |
|
5 |
hybrid-6 relies upon GNU autoconf. The following is a transcript of |
6 |
recommended procedures that users/administrators of hybrid-6 should |
7 |
follow when building and tuning the daemon: |
8 |
|
9 |
1. MOST IMPORTANTLY: Please read "RELNOTES" and "ChangeLog" to get |
10 |
an idea of what bugs were fixed, features were added, or variables |
11 |
were changed. Changes to ircd.conf are documented in doc/example.conf. |
12 |
|
13 |
If you are upgrading from Hybrid6.0 or earlier, you MUST read RELNOTES. |
14 |
|
15 |
2. Run the "configure" script. It will create "include/setup.h" and the |
16 |
Makefiles to match your system: |
17 |
|
18 |
./configure |
19 |
|
20 |
3. Edit the "include/config.h" file. This allows you to change |
21 |
various options of how the ircd will operate. Please make note of |
22 |
the following variables in "include/config.h", as they are common |
23 |
fault points for administrators who are learning how to tune their |
24 |
daemon: |
25 |
|
26 |
HARD_FDLIMIT_ |
27 |
INIT_MAXCLIENTS |
28 |
|
29 |
These two variables **MUST BE LESS** than the maximum number of |
30 |
file descriptors **PER PROCESS** permitted by your kernel, and MUST |
31 |
be <= FD_SETSIZE (usually defined in system includes, but may need to |
32 |
be override by editing the Makefile). Each operating system handles |
33 |
the descriptor definitions differently; in the case of FreeBSD, please |
34 |
use sysctl(8) to check the following MIBs for their values: |
35 |
|
36 |
kern.maxfiles |
37 |
kern.maxfilesperproc |
38 |
|
39 |
Please remember that when starting the daemon, that shell limits |
40 |
may be imposed. Check these by becoming the user who the daemon runs |
41 |
as, and depending upon your shell, use "limit" or "ulimit -a" to check |
42 |
what values are currently imposed. For "limit," look at the number |
43 |
after the "descriptor" description. For "ulimit -a," look at the |
44 |
number after the "open files" description. Understand that this is |
45 |
the MAXIMUM number of descriptors (sockets AND open files) which |
46 |
that user can have. If you believe your daemon is experiencing this |
47 |
(high CPU usage is usually a sign), try using utilities like "ktrace" |
48 |
or "truss" on the running ircd process to find out what troubles it |
49 |
might be having. |
50 |
|
51 |
Note that the old OS definitions are gone; autoconf handles this. |
52 |
|
53 |
Finally, set the various PATHs to where you are going to install the |
54 |
ircd. Do NOT install the ircd to "." -- the install script is not |
55 |
designed to install ircd properly on top of the existing source tree. |
56 |
Doing this will in turn make quite a mess. |
57 |
|
58 |
4. "make" should build ircd. |
59 |
|
60 |
5. "make install" to install the server and tools in the path defined |
61 |
in config.h (DPATH). |
62 |
|
63 |
|
64 |
HOW TO GET HELP: |
65 |
---------------- |
66 |
Send Check or Money Order to... just kidding! Commercial support for |
67 |
ircd-hybrid is not available at this time. |
68 |
|
69 |
However, all hope is not lost; the Hybrid Mailing List is available for |
70 |
general help, and/or questions. To subscribe, use this link: |
71 |
https://lists.ircd-hybrid.org/mailman/listinfo/hybrid |
72 |
|
73 |
If hybrid crashes on you, PLEASE CONTACT bugs@ircd-hybrid.org |
74 |
ASAP with a backtrace of the core. The hybrid team can't fix bugs if |
75 |
no one tells us about them! |
76 |
|
77 |
If there is a new feature you would like to see in the next major |
78 |
release of ircd-hybrid, please post it to the public mailing list, |
79 |
hybrid@lists.ircd-hybrid.org. |
80 |
|