anope

- supernets anope source code & configuration
git clone git://git.acid.vegas/anope.git
README.md (2270B)
      1 ## About
      2 
      3 Anope is an open source set of IRC Services. It is highly modular, with a vast number of configurable parameters, and is the most used IRC services package. There are also many modules on the [modsite](https://modules.anope.org) to add additional features. It runs on Linux, BSD, and Windows, and supports many modern IRCds, including InspIRCd, UnrealIRCd, and ircd-hybrid. For more details, credits, command line options, and contact information see [docs/README](https://github.com/anope/anope/blob/2.0/docs/README).
      4 
      5 * [Website](https://anope.org)
      6 * [GitHub](https://github.com/anope)
      7 * IRC \#anope on irc.anope.org
      8 
      9 ## Installation
     10 
     11 ### Linux/BSD
     12 Download the latest release off of the [releases page](https://github.com/anope/anope/releases).
     13 
     14 
     15 ```
     16 $ ./Config
     17 $ cd build
     18 $ make
     19 $ make install
     20 ```
     21 
     22 Now change to the directory where you installed Anope to, e.g. `$ cd ~/services/`
     23 
     24 ### Windows
     25 Download the latest release off of the [releases page](https://github.com/anope/anope/releases) and run the installer.
     26 
     27 
     28 ## Configuration
     29 
     30 Copy conf/example.conf to conf/services.conf
     31 
     32 ```
     33 $ cp conf/example.conf conf/services.conf
     34 ```
     35 
     36 Edit services.conf, configuring the uplink, serverinfo, and protocol module configurations. Example link blocks for popular IRCds are included in the the example.conf documentation. The [Anope wiki](https://wiki.anope.org) is also a good source of information. Our support channel is located at #anope on [irc.anope.org](irc://irc.anope.org/#anope).
     37 
     38 Note that the example configuration file includes other example configuration files. If you want to modify the other example configuration files, copy them (e.g. `modules.example.conf` to `modules.conf`) and modify the `include` directive in `services.conf` to include the new file.
     39 
     40 ## Running
     41 
     42 Run `$ ./bin/services` to start Anope. If asked to provide logs for support, use the `--support` flag, e.g.: `$ ./bin/services --support`
     43 
     44 ## Installing extra modules
     45 
     46 Extra modules, which are usually modules which require extra libraries to use, such as m\_mysql, can be enabled with the `./extras` command from the source directory. Then re-run `Config`, `make` and `make install` again. Third party modules can be installed by placing them into the `modules/third` directory.