Permalink
Browse files

Add source installation guides.

  • Loading branch information...
1 parent 16d0eeb commit 5247be0638c68395511f9fa2ad49d3dd4e552e6a @SaberUK SaberUK committed May 29, 2012
Showing with 107 additions and 0 deletions.
  1. +55 −0 Installation/Source.md
  2. +52 −0 Module-Manager.md
@@ -0,0 +1,55 @@
+# InspIRCd Wiki » Installation » Source
+
+## Obtaining
+
+There is two methods of obtaining the source code. You can either download the latest release or
+clone the source code from our Git repository.
+
+### Release Tarball
+
+The most common way to install InspIRCd will be using a release tarball. To obtain this, first visit
+the [downloads page](https://github.com/inspircd/inspircd/downloads). Here, you can obtain tarballs
+for release versions.
+
+If you plan to build on a headless server, then you will probably need to use commands similar to
+the following to download and unpack the source:
+
+```sh
+wget https://cloud.github.com/downloads/inspircd/inspircd/InspIRCd-X.Y.Z.tar.bz2
+tar xvf ./InspIRCd-X.Y.Z.tar.bz2
+
+**Note** if you are using a system which does not ship with GNU wget, such as Mac OS X, then you
+will need to replace `wget` in the above example with `curl --remote-name`.
+
+### Git Repository
+
+If you want to use the latest bleeding edge code then your best bet is to use [Git](http://git-scm.com/)
+to clone the InspIRCd repository.
+
+This can be done using the following example:
+
+```sh
+git clone git://github.com/inspircd/inspircd.git
+git checkout insp12 # Optional, switches to the 2.1 branch.
+git checkout insp21 # Optional, switches to the 2.1 branch.
+```
+
+**Note** the source code in Git is often less stable than the source code in a release version. Make
+sure to tread carefully when using it.
+
+## Building
+
+### Configure
+
+To start, execute the `./configure` script in the root directory of your InspIRCd install. You will
+be automatically prompted to answer a series of questions regarding the configuration of your
+server.
+
+A number of options for non-interactive configuration are also available. These options vary between
+versions so you will need to check `./configure --help` for a list of commands.
+
+### Make
+
+Execute the `make` command to build the InspIRCd binaries. This should take about 10 minutes on a
+modern computer. Once make has finished executing, run `make install` to sort the InspIRCd files
+into the target directories that you set in the configure step.
View
@@ -0,0 +1,52 @@
+# InspIRCd Wiki » Module Manager
+
+InspIRCd ships with a tool called `./modulemanager`. This tool allows you to easily install modules
+that are not included with the default distribution, such as third party modules and modules which
+have been backported from later versions. The module manager tool is located in the root directory
+of your InspIRCd installation.
+
+## Syntax
+
+```
+Use: ./modulemanager <action> <args>
+Action is one of the following
+ install install new modules
+ upgrade upgrade installed modules
+ list lists available modules
+
+For installing a package, specify its name or name=version to force the installation of a specific
+version.
+```
+
+## Common errors
+
+### Can't locate LWP/Simple.pm in @INC
+
+Your system is missing the libwww-perl package. You should install it from your appropriate package
+manager.
+
+* **CentOS, Fedora** &mdash; yum install perl-libwww-perl
+* **Debian, Ubuntu** &mdash; apt-get install libwww-perl
+
+
+### Could not retrieve https://raw.github.com/inspircd/inspircd-extras/master/modules.lst
+
+There is a problem with your internet connection or your system is missing LWP SSL support and
+module manager is not detecting this properly.
+
+The latter is a known issue, see [issue #154](https://github.com/inspircd/inspircd/issues/154) for
+more details.
+
+## Installing modules without the module manager
+
+If for some reason you are unable to use the module manager you can download and install modules
+manually using the following steps:
+
+ 1. Download the module you wish to install from the [inspircd-extras](https://github.com/inspircd/inspircd-extras)
+ repository on GitHub.
+
+ 2. Move it to the src/modules directory.
+
+ 3. **1.2 only** Run ./configure -modupdate.
+
+ 4. Run "make install" to build and install the module.

0 comments on commit 5247be0

Please sign in to comment.