# You can replace `wget` with `curl --remote-name` if using cURL.
wget "https://github.com/inspircd/inspircd/archive/[VERSION].tar.gz"

tar -xvf "./inspircd-[VERSION].tar.gz"

git clone --branch insp3 "https://github.com/inspircd/inspircd.git"

# Replace the URL here with the URL you obtained from the releases page.
wget "https://github.com/inspircd/inspircd/releases/download/[VERSION]/inspircd-[VERSION].el7.centos.x86_64.rpm"

# Replace the filename here with the name of the file you obtained from the releases page.
sha256sum "./inspircd-[VERSION].el7.centos.x86_64.rpm"

# Replace the filename here with the name of the file you obtained from the releases page.
sudo yum install "./inspircd-[VERSION].el7.centos.x86_64.rpm"

# Replace the URL here with the URL you obtained from the releases page.
wget "https://github.com/inspircd/inspircd/releases/download/[VERSION]/inspircd_[VERSION]_amd64.deb"

# Replace the filename here with the name of the file you obtained from the releases page.
sha256sum "./inspircd_[VERSION]_amd64.deb"

# Replace the filename here with the name of the file you obtained from the releases page.
sudo apt-get install "./inspircd_[VERSION]_amd64.deb"

InspIRCd Configuration

This page only lists core configuration. For details on the configuration of a specific module please refer to the appropriate page for that module.

<admin>

The <admin> tag defines contact details for the server administrator. This tag can only be defined once.

Example Usage

<admin name="John Doe"
       nick="JDoe123"
       email="[email protected]">

<badhost>

The <badhost> tag defines a permanent K-line. This tag can be defined as many times as required.

Example Usage

<badhost host="*@example.com"
         reason="Spamming">

<badip>

The <badip> tag defines a permanent Z-line. This tag can be defined as many times as required.

Example Usage

<badip ipmask="192.0.2.0/24"
       reason="Spamming">

<badnick>

The <badnick> tag defines a permanent Q-line. This tag can be defined as many times as required.

Example Usage

<badnick nick="NickServ"
         reason="Reserved for a network service">

<bind>

The <bind> tag defines an endpoint to listen for connections on. This tag can be defined as many times as required.

The type field should be set to one of the following values:

Example Usage

Listens for IRC client connections on 192.0.2.1:6667:

<bind address="192.0.2.1"
      port="6667"
      type="clients">

Listens for IRC server connections on *:7000:

<bind port="7000"
      type="servers">

<cidr>

The <cidr> tag defines the number of bits of an IP address that should be looked at when locating clones. This tag can only be defined once.

Example Usage

<cidr ipv4clone="32"
      ipv6clone="128">

<class>

The <class> tag defines a set of server operator privileges. This tag can be defined as many times as required.

Example Usage

<class name="OperChat"
       commands="WALLOPS GLOBOPS"
       privs="users/mass-message"
       chanmodes="*"
       usermodes="*">

<connect>

The <connect> tag defines a class that users can be filtered into when they connect to the server. This tag can be defined as many times as required.

Example Usage

Denies connections to clients connecting from 3ffe::0/32:

<connect name="6bone"
         deny="3ffe::0/32"
         reason="The 6bone address space is deprecated">

Defines an SSL-only connect class and then a general connect class to inherit from:

<connect name="Secure"
         parent="Main"
         port="6697">

<connect name="Main"
         allow="*"
         commandrate="1000"
         fakelag="on"
         globalmax="3"
         hardsendq="1M"
         limit="5000"
         localmax="3"
         maxchans="30"
         maxconnwarn="no"
         pingfreq="120"
         recvq="8K"
         resolvehostnames="yes"
         softsendq="8192"
         threshold="10"
         timeout="10">

Special Notes

If you are also using the cgiirc module you should disable DNS lookups for your WebIRC gateway.

<dns>

The <dns> tag defines the DNS server to use when looking up hostnames. This tag can only be defined once.

Example Usage

<dns server="8.8.8.8"
     timeout="5">

<exception>

The <exception> tag defines a permanent E-line. This tag can be defined as many times as required.

Example Usage

<exception host="*@localhost"
           reason="Local connections">

<insane>

The <insane> tag defines limits to protect against overly wide X-lines being created. This tag can only be defined once.

Example Usage

<insane hostmasks="yes"
        ipmasks="yes"
        nickmasks="yes"
        trigger="95.5">

<limits>

The <limits> tag defines the maximum length of user-configurable fields. This tag can only be defined once.

Example Usage

<limits maxaway="200"
        maxchan="64"
        maxhost="64"
        maxident="11"
        maxkick="255"
        maxmodes="20"
        maxnick="32"
        maxquit="255"
        maxreal="128"
        maxtopic="307">

<log>

The <log> tag defines a location to log to. This tag can be defined as many times as required.

The method field should be set to one of the following values:

The type field should be set to one or more of the following values:

The level field should be set to one of the following values:

Example Usage

<log method="file"
     type="* -USERINPUT -USEROUTPUT"
     level="default"
     target="ircd.log"
     flush="20">

<maxlist>

The <maxlist> tag defines the number of list modes which can be created in a channel. This tag can be defined as many times as required.

Example Usage

<maxlist chan="#largechan"
         mode="b"
         limit="500">

<maxlist chan="*"
         limit="100">

<module>

The <module> tag defines a module to load. This tag can be defined as many times as required.

Example Usage

<module name="ssl_gnutls">

<oper>

The <oper> tag defines a server operator account. This tag can be defined as many times as required.

The following hashing modules are included with InspIRCd:

Example Usage

<oper name="Sadie"
      password="7H8Tqm+i$jaG48RHAcoLXSB3Guzaf1bQehaNRNbblMoNrHPdguvU"
      hash="hmac-sha256"
      class="ServerOperators"
      host="*@bnc.example.com"
      type="NetAdmin"
      vhost="staff.example.net">

<options>

The <options> tag defines general configuration options. This tag can only be defined once.

The casemapping field should be set to one of the following values:

The defaultbind field should be set to one of the following values:

The splitwhois field should be set to one of the following values:

Example Usage

<options allowzerolimit="no"
         casemapping="ascii"
         cyclehostsfromuser="no"
         defaultbind="auto"
         defaultmodes="nost"
         exemptchanops=""
         fixedpart=""
         fixedquit=""
         hostintopic="yes"
         invitebypassmodes="yes"
         nosnoticestack="no"
         prefixpart="&quot;"
         prefixquit="Quit: "
         splitwhois="no"
         suffixpart="&quot;"
         suffixquit=""
         syntaxhints="yes"
         xlinemessage="You're banned. Email [email protected] to appeal this decision.">

<path>

The <path> tag defines the location of the config, data, log, and module directories. This tag can only be defined once.

Example Usage

<path configdir="conf"
      datadir="data"
      logdir="logs"
      moduledir="modules">

<performance>

The <performance> tag defines configuration options relating to server performance. This tag can only be defined once.

Example Usage

<performance clonesonconnect="yes"
             netbuffersize="10240"
             softlimit="15000"
             somaxconn="128"
             timeskipwarn="2s">

<pid>

The <pid> tag defines the location of the pidfile. This tag can only be defined once.

Example Usage

<pid file="inspircd.pid">

<security>

The <security> tag defines configuration options relating to server security. This tag can only be defined once.

The announceinvites field should be set to one of the following values:

The restrictbannedusers field should be set to one of the following values:

Example Usage

<security allowcoreunload="no"
          announceinvites="dynamic"
          customversion=""
          genericoper="no"
          hidebans="yes"
          hidekills=""
          hideserver=""
          hidesplits="no"
          hideulinekills="yes"
          maxtargets="20"
          restrictbannedusers="yes"
          runasgroup=""
          runasuser=""
          userstats="Pu">

<server>

The <server> tag defines settings about the local server. This tag can only be defined once.

Example Usage

<server name="irc.eu.example.com"
        description="ExampleNet's European server"
        network="ExampleNet"
        id="34C">

<type>

The <type> tag defines a type of server operator. This tag can be defined as many times as required.

Example Usage

<type name="NetAdmin"
      class="ServerOperators"
      classes="BanControl HostCloak OperChat SACommands ServerLink Shutdown"
      vhost="staff.example.net">

<whowas>

The <whowas> tag defines the configuration of the /WHOWAS database. This tag can only be defined once.

Example Usage

<whowas groupsize="10"
        maxgroups="100000"
        maxkeep="3d">