Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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