Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 193 lines (130 sloc) 8.394 kb
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
1 Frequently Asked Questions
2 --------------------------
3
4 Why should I choose InspIRCd over some other IRC server?
5 --------------------------------------------------------
6
7 There are several reasons to choose InspIRCd over some other IRC server. These are:
8
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
9 * InspIRCd is totally modular -- add and remove features as YOU please, not as we tell you to. This
10 modular design also allows you to upgrade most parts (including but not limited to core commands,
11 server linking and SSL support) without rebooting the IRC server.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
12
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
13 * InspIRCd offers its own free (as in beer *and* freedom) implementation of many features which
14 developers of certain other IRC servers want to charge you for.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
15
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
16 * InspIRCd has a highly scalable ''non-blocking'' SQL API, supporting, MySQL, PostgreSQL, SQL
17 Server and SQLite -- unseen in any other IRC server.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
18
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
19 * InspIRCd has high-performance socket engines such as epoll and kqueue, whereas other IRC servers
20 with the same feature set do not. We also have some socket engines that no other IRC server has
21 currently, such as Windows I/O Completion Ports, which increases the performance of our Windows
22 builds beyond most other Windows IRC servers.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
23
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
24 * The InspIRCd development team welcome third party contributions, suggestions and criticism whereas
25 many of the developers of alternative IRC servers do not.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
26
27 How much memory does InspIRCd use?
28 ----------------------------------
29
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
30 A network with 3000-4000 locally connected clients and 10000 open channels experiences a constant
31 1-4% CPU use with 70MB of RAM use. This won't go up drastically, but it will go up. Around 40000
32 local clients means you'll be expecting some 500MB of RAM.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
33
34 How do I start InspIRCd?
35 ------------------------
36
37 Navigate to the directory in which you installed InspIRCd and issue the following command:
38
39 ./inspircd start
40
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
41 Note: these instructions only apply if you installed InspIRCd from source on a UNIX-like operating
42 system. If you installed InspIRCd from a package manager it will probably not use this method.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
43
44 Can my network be the "official" InspIRCd network?
45 --------------------------------------------------
46
47 Sorry, no. That privilege is reserved for our own network at [irc.chatspike.net](irc://irc.chatspike.net/).
48
49 What services package should I choose?
50 --------------------------------------
51
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
52 This is an extremely subjective question. It is advised that you trial multiple different packages
53 and use the one that you feel fits your needs.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
54
55 Popular IRC services packages used with InspIRCd include:
56
57 * [Anope](http://www.anope.org/)
58 * [Atheme](http://www.atheme.net/)
59
60 Use of [IRCServices](http://achurch.org/services/) is not recommended due to it being unsupported.
61
62 Where should I report a bug/suggest a feature?
63 ----------------------------------------------
64
65 On the appropriate issue tracker:
66
67 * [Main](https://github.com/inspircd/inspircd/issues)
68 * [Extras](https://github.com/inspircd/inspircd-extras/issues)
69 * [Website](https://github.com/inspircd/inspircd.github.com/issues)
70 * [Wiki](https://github.com/inspircd/wiki/issues)
71
72 How can I contribute to InspIRCd?
73 ---------------------------------
74
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
75 Take a look at our [Contributing](https://github.com/inspircd/wiki/blob/master/Contributing.md)
76 page.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
77
78 Can I use InspIRCd on my large network?
79 ---------------------------------------
80
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
81 Feel free! We have tested InspIRCd up to 80000 clients on a single server. If you have any
82 statistics on performance you would like to share, then get in touch.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
83
84 Do any large networks use InspIRCd?
85 -----------------------------------
86
87 To our knowledge, the largest networks using InspIRCd are:
88
89 * [IrCQ-Net](irc://irc.icq.com/) with 4000-6000 users
90 * [Barafranca](irc://irc.barafranca.com/) with 1400-3500 users
91 * [Chatspike](irc://irc.chatspike.net) with 600-1400 users
92
93 Which socket engines are supported by InspIRCd?
94 -----------------------------------------------
95
96 The following high performance socket engines are supported:
97
98 * **select** on all operating systems
99 * **poll** on all UNIX-like operating systems
100 * **kqueue** on BSD and Mac OS X
101 * **epoll** on Linux.
102 * **iocp** on Windows
103
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
104 Please note that the performance improvements given by use of kqueue, iocp or epoll are very large
105 performance gains over select(), and should be used wherever they are available. If you do not have
106 any of these socket engines, you should seriously consider upgrading your operating system or kernel
107 before running an IRC server.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
108
109 What IRCd is InspIRCd based on?
110 -------------------------------
111
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
112 None. Yes that's right, None. We didn't start from anyone else's code, at all. It is not based on
113 Unreal, it is not based on Bahamut, nor is it based on any other IRCd. This is what makes it unique.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
114
115 Can I run InspIRCd as root?
116 ---------------------------
117
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
118 You could run the InspIRCd binary with the --runasroot parameter, but we will not provide any
119 support for doing this. If you want to bind InspIRCd to a privileged port, you should instead
120 use a port forwarding rule in your firewall. For example, if you are using Linux with iptables:
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
121
122 iptables -t nat -A PREROUTING -p tcp -i eth0 -d 127.0.0.1 --dport 194 -j DNAT --to 127.0.0.1:6667
123 iptables -A FORWARD -p tcp -i eth0 -d 127.0.0.1 --dport 194 -j ACCEPT
124
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
125 This will forward all traffic on port 194 to port 6667, on the IP 127.0.0.1. You should change this
126 IP and port numbers as appropriate.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
127
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
128 If you are running Linux, another solution is to enable [file system capabilities](http://www.friedhoff.org/fscaps.html)
129 in your kernel, which allows you to grant specific privileges (e.g. the ability to bind to ports
130 under 1024) to any process without having to run it as root.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
131
132 On FreeBSD and similar systems, there is a sysctl OID for this, which you can set:
133
134 net.inet.ip.portrange.reservedlow=1
135 net.inet.ip.portrange.reservedhigh=1
136
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
137 This will allow non-root processes to bind any ports which are above port 1, essentially all
138 available port numbers.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
139
140 How do I run InspIRCd when the system starts?
141 ---------------------------------------------
142
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
143 To launch InspIRCd when your system starts, you should place the following line into the crontab for
144 your IRCd user (crontab -e):
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
145
146 @reboot cd /home/user/inspircd; ./inspircd start
147
148 How do I get prefixes like `@`, `~` and `&`?
149 -------------------------------------------
150
151 If you are using InspIRCd 1.2, load [m_customprefix](https://github.com/inspircd/wiki/blob/master/Modules/customprefix.md).
152
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
153 If you are using InspIRCd 2.0 or newer, load [m_halfop](https://github.com/inspircd/wiki/blob/master/Modules/halfop.md)
154 and [m_chanprotect](https://github.com/inspircd/wiki/blob/master/Modules/halfop.md).
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
155
156 Why does my server have none of the advertised features?
157 --------------------------------------------------------
158
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
159 By default, InspIRCd only supports features specified in [RFC 1459](http://tools.ietf.org/html/rfc1459).
160 If you want to add extra features then you must load the correct modules. A list of modules can be
161 found in `docs/inspircd.conf.example`.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
162
163 Why do I get a 'Loader/Linker' error when loading a module?
164 -----------------------------------------------------------
165
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
166 The version of InspIRCd which the module was compiled for is different to your server. Run
167 `make clean` and then `make install` to rebuild everything on the same version.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
168
169 When I run my IRC server it exits saying 'Failed to write PID-file'
170 -------------------------------------------------------------------
171
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
172 There is a syntax error in your configuration file. To show the real error, move the \<pid\> tag to
173 the top of your configuration.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
174
175 How can I use channel admin commands such as kick/mode without having op?
176 -------------------------------------------------------------------------
177
178 Load [m_override](https://github.com/inspircd/wiki/blob/master/Modules/override.md).
179
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
180 Please note that this module must be loaded on all servers of your network or your mode changes may
181 be reversed and/or you may cause desyncs.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
182
183 When users connect, InspIRCd never resolves their ident
184 -------------------------------------------------------
185
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
186 Ident lookups on InspIRCd are provided by [m_ident](https://github.com/inspircd/wiki/blob/master/Modules/ident.md).
187 You must load this module for them to be resolved.
36cbdad @SaberUK Start moving wiki to GitHub.
SaberUK authored
188
189 Can InspIRCd make cheese sandwiches?
190 ------------------------------------
191
dc39ffe @SaberUK Normalize all text to be 100 characters max.
SaberUK authored
192 Yes, providing that you load the [m_cheesesandwich](https://github.com/inspircd/wiki/blob/master/Modules/m_cheesesandwich.md)
193 module.
Something went wrong with that request. Please try again.