-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME
36 lines (36 loc) · 2.97 KB
/
README
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
<h1>cmpctircd</h1>
<h2>About</h2>
<p>The aim of this project was to provide a stable, fast, and <em>modern</em> ircd.</p>
<h2>Status</h2>
<p><strong>This project has been deprecated in favour of <a href="https://git.cmpct.info/cmpctircd.NET.git">cmpctircd.NET</a>.</strong></p>
<p><strong>No further development will take place on this project by sam et al.; contact sam if you wish to take over.</strong>
<strong>Anyone wishing to take on the project would be supported by the cmpct collective.</strong></p>
<h2>Testing</h2>
<p>Checkout <em>master</em>, edit <code>ircd.xml</code>, and run <code>bin/ircd --config ircd.xml --motd ircd.motd --rules ircd.rules</code> to test.
Windows/others should use <code>select</code> as the socket provider (<code><sockets:provider></code>). <code>epoll</code> is recommended on Linux, with <code>kqueue</code> for *BSD.</p>
<p>Use parameter <code>--loglevel $LEVEL</code> where <code>$LEVEL</code> is one of: <code>DEBUG, WARN, INFO, ERROR</code> to control the logging level. TLS certs and keys should be 'tls_cert.pem' and 'tls_key.pem' respectively. Install with <code>./Makefile.PL; make; (sudo) make install</code>.</p>
<h2>Dependencies</h2>
<ul>
<li>Net::DNS (libnet-dns-perl, only if <code><advanced:dns></code> is enabled)</li>
<li>IO::Socket::SSL (libio-socket-ssl-perl, only if <code><server:tls></code> is enabled)</li>
<li>IO::Epoll (libio-epoll-perl, only if <code><sockets:provider></code> is <code>epoll</code>)</li>
<li>IO::KQueue (N/A, only if <code><sockets:provider></code> is <code>kqueue</code>)</li>
<li>XML::Simple (libxml-simple-perl)</li>
<li>Datetime (libdatetime-perl)</li>
<li>Path::Tiny (libpath-tiny-perl)</li>
<li>Module::Install (libmodule-install-perl)</li>
<li>Try::Tiny (libtry-tiny-perl)</li>
<li>String::Scanf (libstring-scanf-perl)</li>
<li>Term::ANSIColor (within core on Debian)</li>
<li>Getopt::Long (within core on Debian)</li>
<li>Tie::Refhash (within core on Debian)</li>
<li><code>perl >= 5.20</code> for <code>postderef</code></li>
</ul>
<h2>Branches</h2>
<p><em>You can use Bugzilla to glean information about the direction of a series.</em></p>
<ul>
<li>master: stable development, <a href="https://bugs.cmpct.info/buglist.cgi?f1=target_milestone&f2=target_milestone&j_top=AND_G&list_id=770&o1=lessthan&o2=greaterthaneq&order=bug_status%20DESC%2Cchangeddate%20DESC%2Cpriority%2Cassigned_to%2Cbug_id&product=cmpctircd&query_format=advanced&resolution=---&v1=0.3.0&v2=0.2.0">0.2.x</a> series (bugfixes, small new features)</li>
<li>next: next major version, <a href="https://bugs.cmpct.info/buglist.cgi?f1=target_milestone&f2=target_milestone&f3=target_milestone&j_top=AND_G&list_id=771&o1=lessthan&o2=greaterthaneq&product=cmpctircd&query_format=advanced&resolution=---&v1=0.4.0&v2=0.3.0">0.3.x</a> series (link work, etc)</li>
</ul>
<h2>Contact</h2>
<p>Email me at sam@cmpct.info if you wish to contribute or you have questions.</p>