Permalink
Browse files

Pointer to the new gh-pages branch.

  • Loading branch information...
1 parent ef97192 commit fbaa29b1b17af5bbed2ebbc5ae4947a58c695b43 @SaberUK SaberUK committed Aug 9, 2012
View
@@ -1,41 +0,0 @@
-# InspIRCd Wiki » Contributors
-
-## Introduction
-
-The InspIRCd project is quite open to all contributions, large and small. Whether you're a coder,
-documentation writer, tester or ''<insert role here>'', we're sure you will help out in a useful
-way.
-
-This page documents a bit of how we work internally as a project, so that you can better fit in and
-help out if you want.
-
-## Ways to Contribute
-
-### Development
-
-The development team is of a loosely connected group of contributors, all working and collaborating
-on things they want to see done. We don't really assign work to anyone, they find stuff to work on
-on their own generally.
-
-You can find repositories on [GitHub](http://github.org/inspircd/).
-
-If you wish to contribute to development, feel free. File as many pull requests as you want. Pull
-requests that fix existing issues are especially welcome.
-
-If you ever need to make a release, see the [release procedure](https://github.com/inspircd/wiki/blob/master/Release-Procedure.md)
-page for help.
-
-### Documentation
-
-Not everyone who can code is stellar at writing things up in a clear, easy to use way - this is
-where people can help out quite often, by making our numerous features easy to understand.
-Alternatively, perhaps you are interested in helping to translate our documentation into the
-language of your choice. Most of the action in this department takes place here on our wiki.
-
-### Support
-
-Support is a largely informal area, provided by other users and team members. To help out, hang
-around in [#inspircd](irc://irc.inspircd.org/inspircd) (we don't mind idlers!) and answer questions
-if you know what it's about.
-
-We don't bite. Honest.
View
@@ -1,170 +0,0 @@
-# InspIRCd Wiki &raquo; Frequently Asked Questions
-
-## Why should I choose InspIRCd over some other IRC server?
-
-There are several reasons to choose InspIRCd over some other IRC server. These are:
-
-* InspIRCd is totally modular -- add and remove features as YOU please, not as we tell you to. This
-modular design also allows you to upgrade most parts (including but not limited to core commands,
-server linking and SSL support) without rebooting the IRC server.
-
-* InspIRCd offers its own free (as in beer *and* freedom) implementation of many features which
-developers of certain other IRC servers want to charge you for.
-
-* InspIRCd has a highly scalable ''non-blocking'' SQL API, supporting, MySQL, PostgreSQL, SQL
-Server and SQLite -- unseen in any other IRC server.
-
-* InspIRCd has high-performance socket engines such as epoll and kqueue, whereas other IRC servers
-with the same feature set do not. We also have some socket engines that no other IRC server has
-currently, such as Windows I/O Completion Ports, which increases the performance of our Windows
-builds beyond most other Windows IRC servers.
-
-* The InspIRCd development team welcome third party contributions, suggestions and criticism whereas
-many of the developers of alternative IRC servers do not.
-
-## How much memory does InspIRCd use?
-
-A network with 3000-4000 locally connected clients and 10000 open channels experiences a constant
-1-4% CPU use with 70MB of RAM use. This won't go up drastically, but it will go up. Around 40000
-local clients means you'll be expecting some 500MB of RAM.
-
-## How do I start InspIRCd?
-
-Navigate to the directory in which you installed InspIRCd and issue the following command:
-
- ./inspircd start
-
-Note: these instructions only apply if you installed InspIRCd from source on a UNIX-like operating
-system. If you installed InspIRCd from a package manager it will probably not use this method.
-
-## Can my network be the "official" InspIRCd network?
-
-Sorry, no. That privilege is reserved for our own network at [irc.chatspike.net](irc://irc.chatspike.net/).
-
-## What services package should I choose?
-
-This is an extremely subjective question. It is advised that you trial multiple different packages
-and use the one that you feel fits your needs.
-
-Popular IRC services packages used with InspIRCd include:
-
-* [Anope](http://www.anope.org/)
-* [Atheme](http://www.atheme.net/)
-* [IRCServices](http://achurch.org/services/) (**No longer recommended** due to it being unsupported.)
-
-## Where should I report a bug/suggest a feature?
-
-On the appropriate issue tracker:
-
-* [Main](https://github.com/inspircd/inspircd/issues)
-* [Extras](https://github.com/inspircd/inspircd-extras/issues)
-* [Website](https://github.com/inspircd/inspircd.github.com/issues)
-* [Wiki](https://github.com/inspircd/wiki/issues)
-
-## How can I contribute to InspIRCd?
-
-Take a look at our [Contributing](https://github.com/inspircd/wiki/blob/master/Contributing.md)
-page.
-
-## Can I use InspIRCd on my large network?
-
-Feel free! We have tested InspIRCd up to 80000 clients on a single server. If you have any
-statistics on performance you would like to share, then get in touch.
-
-## Do any large networks use InspIRCd?
-
-To our knowledge, the largest networks using InspIRCd are:
-
-* [IrCQ-Net](irc://irc.icq.com/) with 4000-6000 users
-* [Barafranca](irc://irc.barafranca.com/) with 1400-3500 users
-* [Chatspike](irc://irc.chatspike.net) with 600-1400 users
-
-## Which socket engines are supported by InspIRCd?
-
-The following high performance socket engines are supported:
-
-* **select** on all operating systems
-* **poll** on all UNIX-like operating systems
-* **kqueue** on BSD and Mac OS X
-* **epoll** on Linux.
-* **iocp** on Windows
-
-Please note that the performance improvements given by use of kqueue, iocp or epoll are very large
-performance gains over select(), and should be used wherever they are available. If you do not have
-any of these socket engines, you should seriously consider upgrading your operating system or kernel
-before running an IRC server.
-
-## What IRCd is InspIRCd based on?
-
-None. Yes that's right, None. We didn't start from anyone else's code, at all. It is not based on
-Unreal, it is not based on Bahamut, nor is it based on any other IRCd. This is what makes it unique.
-
-## Can I run InspIRCd as root?
-
-You could run the InspIRCd binary with the --runasroot parameter, but we will not provide any
-support for doing this. If you want to bind InspIRCd to a privileged port, you should instead
-use a port forwarding rule in your firewall. For example, if you are using Linux with iptables:
-
- iptables -t nat -A PREROUTING -p tcp -i eth0 -d 127.0.0.1 --dport 194 -j DNAT --to 127.0.0.1:6667
- iptables -A FORWARD -p tcp -i eth0 -d 127.0.0.1 --dport 194 -j ACCEPT
-
-This will forward all traffic on port 194 to port 6667, on the IP 127.0.0.1. You should change this
-IP and port numbers as appropriate.
-
-If you are running Linux, another solution is to enable [file system capabilities](http://www.friedhoff.org/fscaps.html)
-in your kernel, which allows you to grant specific privileges (e.g. the ability to bind to ports
-under 1024) to any process without having to run it as root.
-
-On FreeBSD and similar systems, there is a sysctl OID for this, which you can set:
-
- net.inet.ip.portrange.reservedlow=1
- net.inet.ip.portrange.reservedhigh=1
-
-This will allow non-root processes to bind any ports which are above port 1, essentially all
-available port numbers.
-
-## How do I run InspIRCd when the system starts?
-
-To launch InspIRCd when your system starts, you should place the following line into the crontab for
-your IRCd user (crontab -e):
-
- @reboot cd /home/user/inspircd; ./inspircd start
-
-## How do I get prefixes like `%`, `~` and `&`?
-
-If you are using InspIRCd 1.2, set `<options:allowhalfop>` to yes and load [m_chanprotect](https://github.com/inspircd/wiki/blob/master/Modules/chanprotect.md).
-
-If you are using InspIRCd 2.0 or newer, load [m_customprefix](https://github.com/inspircd/wiki/blob/master/Modules/customprefix.md).
-
-## Why does my server have none of the advertised features?
-
-By default, InspIRCd only supports features specified in [RFC 1459](http://tools.ietf.org/html/rfc1459).
-If you want to add extra features then you must load the correct modules. A list of modules can be
-found in `docs/inspircd.conf.example`.
-
-## Why do I get a 'Loader/Linker' error when loading a module?
-
-The version of InspIRCd which the module was compiled for is different to your server. Run
-`make clean` and then `make install` to rebuild everything on the same version.
-
-## When I run my IRC server it exits saying 'Failed to write PID-file'
-
-There is a syntax error in your configuration file. To show the real error, move the `<pid>` tag to
-the top of your configuration.
-
-## How can I use channel admin commands such as kick/mode without having op?
-
-Load [m_override](https://github.com/inspircd/wiki/blob/master/Modules/override.md).
-
-Please note that this module must be loaded on all servers of your network or your mode changes may
-be reversed and/or you may cause desyncs.
-
-## When users connect, InspIRCd never resolves their ident
-
-Ident lookups on InspIRCd are provided by [m_ident](https://github.com/inspircd/wiki/blob/master/Modules/ident.md).
-You must load this module for them to be resolved.
-
-## Can InspIRCd make cheese sandwiches?
-
-Yes, providing that you load the [m_cheesesandwich](https://github.com/inspircd/wiki/blob/master/Modules/cheesesandwich.md)
-module.
View
@@ -1,28 +0,0 @@
-# InspIRCd Wiki &raquo; [#InspIRCd](irc://irc.chatspike.net/inspircd) Channel Rules
-
-As with most IRC channels, the support channel has rules. These rules are as follows:
-
-* The main purpose of the channel is for support and discussion of InspIRCd. Other off-topic
-discussion is allowed, but keep it to a minimum when on-topic discussion is happening.
-
-* When asking for support make sure to state your full InspIRCd version as well as your Operating
-System name/version and compiler name/version.
-
-* We are here to contribute to the project in some way. Contribute positively. Avoid flaming and
-arguments.
-
-* Constructive criticism directly related to InspIRCd or an module of InspIRCd is welcomed. By
-constructive this means you must give recommendations of how it should be improved.
-
-* Outright bashing of people, programs, and ideas without a reasoned argument (e.g. just "its crap")
-its frowned upon and makes you look an idiot.
-
-* If you find a bug, PLEASE report it to the [bugtracker](https://github.com/inspircd/inspircd/issues)
-rather than the channel. This makes processing it much easier to manage.
-
-* Please use a [pastebin](http://nopaste.snit.ch) if you wish to contribute config file snippets or
-code to the channel, rather than pasting, or you will be automatically kicked.
-
-* No stupid scripts please (e.g. l33tsp33k-converters, 'thanks for the op' scripts, etc).
-
-* Idlers are welcome on #InspIRCd. Helpful people are even more welcome!
Deleted file not rendered
View
Deleted file not rendered
View
Deleted file not rendered
View
@@ -1,22 +0,0 @@
-# InspIRCd Wiki &raquo; Installation
-
-There are many different methods for installing InspIRCd. You will need to pick the one which fits
-your needs best.
-
-Before you start, you may wish to consult the [system requirements](https://github.com/inspircd/wiki/blob/master/System-Requirements.md)
-and [supported operating systems](https://github.com/inspircd/wiki/blob/master/Supported-Operating-Systems.md).
-
-To build from source:
-
-* [Source Installation](https://github.com/inspircd/wiki/blob/master/Installation/Source.md) &mdash;
- a guide to the methods through which you can obtain a copy of the InspIRCd source code and build
- it on your UNIX-like system.
-
-* [Extra Modules](https://github.com/inspircd/wiki/blob/master/Module-Manager.md) &mdash; a guide
- to adding extra and/or non-standard modules via the module manager.
-
-The following operating systems have prebuilt packages available:
-
-* [Mac OS X](https://github.com/inspircd/wiki/blob/master/Installation/Mac-OS-X.md)
-
-* [Windows](https://github.com/inspircd/wiki/blob/master/Installation/Windows.md)
@@ -1,39 +0,0 @@
-# InspIRCd Wiki &raquo; Installation &raquo; Mac OS X
-
-InspIRCd packages are available in the [Homebrew package manager](http://mxcl.github.com/homebrew/).
-
-## Installation
-
-First, ensure that your copy of Homebrew is up to date by executing the following command:
-
-```sh
-brew update
-```
-
-Once you have done this, subscribe to the `SaberUK/irc` tap using the following command:
-
-```sh
-brew tap SaberUK/irc
-```
-
-Now that your copy of Homebrew knows about the InspIRCd packages, you can install the InspIRCd
-packages using one of the following commands:
-
-```sh
-brew install inspircd12 # InspIRCd 1.2
-brew install inspircd20 # InspIRCd 2.0
-brew install inspircd21 # InspIRCd 2.1
-```
-
-InspIRCd will now be downloaded and installed from source. Once it has finished installing, it will
-be available as a keg-only package in your Homebrew directory. This will usually be located at
-`/usr/local/Cellar/inspircdXX/X.Y.Z/`.
-
-## Notable Limitations
-
-* Extra modules such as SSL are not currently available. If you need these then you may wish to
- [build from source](https://github.com/inspircd/wiki/blob/master/Installation.md).
-
-## Related Links
-
-* [SaberUK/homebrew-irc on GitHub](https://github.com/SaberUK/homebrew-irc).
@@ -1,56 +0,0 @@
-# InspIRCd Wiki &raquo; Installation &raquo; Source
-
-## Obtaining
-
-There are 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 is by using a release tarball. To obtain this, first visit
-the [downloads page](https://github.com/inspircd/inspircd/downloads). There you can obtain tarballs
-for release versions.
-
-If you plan to build on a headless server you will probably need to use commands similar to
-the following in order 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 that does not have 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 1.2 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.
@@ -1,21 +0,0 @@
-# InspIRCd Wiki &raquo; Installation &raquo; Windows
-
-InspIRCd packages are available on the [InspIRCd download page](https://github.com/inspircd/inspircd/downloads).
-
-## Installation
-
-First, download the installer from the download page (linked above).
-
-Once you have downloaded the installer, execute it and follow the instructions on screen.
-
-Once it has finished installing, it will be available in `C:\Program Files\InspIRCd` on 32-bit
-Windows and `C:\Program Files (x86)\InspIRCd` on 64-bit Windows.
-
-## Notable Limitations
-
-* The Windows GUI is not yet available on the latest releases.
-* InspIRCd 2.1 beta does not currently build on Windows. See issue #144 for more details.
-
-## Related Links
-
-* [Issue #144 on GitHub](https://github.com/inspircd/inspircd/issues/144).
Oops, something went wrong.

0 comments on commit fbaa29b

Please sign in to comment.