Skip to content

HTTPS clone URL

Subversion checkout URL

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