Installation From Tarball

From the makers of InspIRCd.

Contents 1 Building and Installing InspIRCd 1.1 Download 1.1.1 Release 1.1.2 GIT 1.1.2.1 Switching to a Development Branch 1.1.2.2 Updating 1.2 Extract 1.3 Optional: Add Extra Modules 1.4 Configure 1.5 Build 2 Configuring and Running 2.1 Edit Configuration 2.2 Run! 3 Notes 3.1 Privileges 3.2 Adding Modules 3.3 Nonstandard Paths

Building and Installing InspIRCd

Download

There are two choices for downloading InspIRCd. Depending on the resources available to you, and what you require, you can either install it from a tarball, or via git. The two possibilities are documented below.

Release

To download the latest InspIRCd release you may use this command.

wget "http://www.inspircd.org/?p=download"

You can also download the latest tarball directly from here

GIT

Check out the latest version of InspIRCd from our our git repository or create a clone of the repository using

git clone git://gitorious.org/inspircd/inspircd.git

This will download all branches and check out the most recent stable branch.

Switching to a Development Branch

To check out another branch such as 2.0, run:

git checkout -b insp20 origin/insp20

This will create a local branch for the 2.0 branch; once this is done, you can switch between branches using git checkout insp12 and git checkout insp20

Updating

To fetch updates, simply run git pull which will update the current branch. If you have multiple branches in your repository, you will need to update each one on its own (although the updates will only be downloaded the first time).

Extract

If you got a tarball of InspIRCd (not directly from git) then extract it with:

 tar xjf tarballfilename.tar.bz2

Optional: Add Extra Modules

If you want to add any modules with dependencies in src/modules/extra/ then do this now (Note: ./configure automatically does this for the ssl modules if you answer yes and it detects the required libraries):

cd src/modules
ln -s extra/m_moduleiwant.cpp

Also if you want to add any modules from the Unofficial Modules SVN Repository then do this now, make sure you copy or link them to src/modules.

NOTE: This is an optional example. Do not type this command literally, and do not symlink anything unless you need it! If you have already built InspIRCd once, you may proceed to Adding Modules.

Configure

Run the ./configure script in the InspIRCd base directory and enter the details of your server when prompted. Remember that the values you enter here are constrained by the 512 maximum character limit on a line, so there's no point setting the maximum topic length to 1024 chars when you're only going to be able to use about 420 of them.

Build

Type 'make' to build the ircd binaries, if configure has not already done this. Then type 'make install' to install them, you can skip 'make' and go straight to 'make install' if you're lazy. It'll work.

Configuring and Running

Edit Configuration

Edit your Configuration files, it's easiest to copy docs/inspircd.conf.example to conf/inspircd.conf and edit that. See the Modules List to find specific documentation for modules' config. See the wiki page on Configuration for more details on the core configuration.

Run!

Start inspircd with ./inspircd start, make sure you execute the script in the InspIRCd base directory and not the binary in bin/ (or wherever you told configure to install the binaries to) See the page on Commandline Parameters for more details on how you can use the script.

Notes

Privileges

It is easiest to do all configuration as compiling the non-privileged user that InspIRCd will run as. root access is not needed for any part of the configuration and building (unless you install it to a privileged directory, but don't do that).

Adding Modules

If you want to add a module which you did not install to start with then copy or link the module's .cpp to src/modules, then run:

./configure -modupdate

and then

make install

Nonstandard Paths

If you have libraries installed in non-standard places, such as a local install of libgnutls in your home directory then you need the path to the binaries of your local install in your $PATH variable. You can (temporarily) add a path to $PATH by running:

export PATH=/your/path:"${PATH}"

And then running configure and make as normal, to make the path changes permanent you need to put the PATH definition into your shell's startup script.