START HERE!
Contents |
Before You Begin
Before you begin, you should be aware of what kind of network you want. Different IRCds and services combinations will all have different results. If you are here, we're assuming you have decided to use Anope with your IRCd of choice or you are looking for more information to make your choice. If you're still undecided, please see our comparison chart. This tutorial may also help you with your decision.
NOTE: Example file names are used in this tutorial. When you see anope-1.8.x you need to substitute the x with the version of Anope you are using. Ex. anope-1.8.0.tar.gz
What You Will Need
Shell/computer - Some people will rent a "shell" from a hosting company to run IRC processes on. These are generally inexpensive and usually use linux or FreeBSD. If you need a host, please check out our sponsors. Many people also choose to run IRC servers on their home computers. To do this, you only need to select an IRCd and services package that will run on your operating system. For Windows, there are many choices. Mac users can generally run the linux versions of software without any issues. If you run linux at home, you can obviously use the linux versions!
tarball/zip file - These are compressed files or archives of the packages you will need. You will need to extract them in order to install the software. We will go over this later on.
General knowledge of your operating system - It is important that you have some basic knowledge of your operating system. Trying to set up an IRC server on a system you know nothing about may not work out so well.
Setting Up the IRCd
This will depend on what IRCd you choose. To see what IRCd's Anope works with, please see the IRCd list.
It is important to note that you will need a way to link Anope and your IRCd. Please make sure you read the documentation from your IRCd on linking servers.
How to Install Anope
Unix/Linux
WARNING: You do not need to run Anope as the root superuser. We suggest that you run Anope from a non-root user account so that in the (unlikely) event an exploit is found that could compromise your system, your version of Anope won't have privileges. We also recommend that you install Anope from the user account that you are going to be running Anope from. Root is not needed for installing or running Anope - Don't use it!
To install Anope on Unix/Linux, go to our downloads page and click anope-stable. Click the Platform-Independent version to download it.
Extract the files with the following command:
tar -xvf anope-1.8.x.tar.gz
Extracting the files should leave you with a directory called anope-1.8.x. Type the following command to enter the directory:
cd anope-1.8.x
In the anope-1.8.x directory, you will need to type:
./Config
This will start a configuration script that will ask you some questions about where and how you want to compile Anope.
NOTE: Documentation on the Config script will be added later.
After the ./Config script finishes, you need to type:
make
NOTE: If you get permission denied after typing make, try typing:
gmake
After make or gmake finishes, type:
make install
Anope is now installed.
WARNING: Do not delete the anope-1.8.x directory after you have installed Anope. You will need it if you ever want to compile modules!!!
You now need to go to your services directory. To do this type:
cd && cd services
You will need to edit the configuration file. To see an in depth explanation of what you need to edit, click here.
Once you have edited your configuration file, type:
./services
This should start Anope. To see if it started, type the following command and look for a process called services:
ps ux
Windows
To install Anope on Windows, go to our downloads page and click anope-stable.
You are presented with 3 options:One tar.gz file and 2 .exe files.
If you would like to use Anope with MySQL support, click anope-1.8.x-mysql.exe. Please note that MySQL is not live. This means that you will not be able to use Anope's MySQL support to create dynamic webpages.
If you would like to use Anope without MySQL support, click anope-1.8.x.exe.
The .exe installer whill guide you through the process of installing Anope. It is advised that you use the default installation path, but you can change it if need be.
The installer will prompt you to add a shortcut to the desktop. This is advisable, but you can start Anope from the command prompt or Start Menu.
Troubleshooting
For troubleshooting tips, please see our Troubleshooting section. If you are still having problems, please visit our support channel or post on the forums