anope- supernets anope source code & configuration |
| git clone git://git.acid.vegas/anope.git |
| Log | Files | Refs | Archive | README |
README (11025B)
1 Anope -- a set of IRC services for IRC networks 2 ----------------------------------------------- 3 4 Anope is 2003-2022 Anope Team <team@anope.org>. 5 Based on Epona 2000-2002 PegSoft <epona@pegsoft.net>. 6 Based on Services 1996-1999 Andrew Church <achurch@achurch.org>. 7 8 This program is free but copyrighted software; see the file COPYING for 9 details. 10 11 Information about Anope may be found at https://www.anope.org/ 12 13 Table of Contents 14 ----------------- 15 1) Credits 16 2) Presentation 17 3) Installation 18 4) Command Line Options 19 5) Messages Translation 20 6) Contact 21 22 1) Credits 23 24 Anope is based on Lara's Epona version 1.4.14. 25 Epona is based on Andy Church's IRC Services version 4.3.3. 26 27 The original credits: 28 29 * Mauritz Antunes 30 Portuguese translation 31 * Jose R. Holzmann, Raul S. Villarreal 32 Spanish translation 33 * Andrew Kempe <theshadow@shadowfire.org> 34 News system 35 * <d.duca@eurcom.net> 36 Italian translation 37 * <mikado@holyfire.com> 38 Turkish translation 39 * Andrew Kempe <theshadow@shadowfire.org> 40 Session limiting 41 42 Epona credits: 43 44 * lara <lara@pegsoft.net> 45 Main coding 46 * CafeiN <oytuny@yahoo.com> 47 Turkish translation 48 * Sylvain Cresto aka tost <scresto@netsante.fr> 49 FreeBSD 5 patch 50 * Marcelo Conde Foscarini aka Bras <ircadmin@brmarket.net> 51 Portuguese translation 52 * Alvaro Toledo aka POLLITO <atoledo@keldon.org> 53 Spanish translation 54 * chemical <chemical@musicplay.de> 55 German translation 56 * shine <dh@shinewelt.de> 57 German translation 58 * Guven Guzelbey aka MeShGuL <guzelbey@cs.utk.edu> 59 Turkish translation 60 * Jordi Pujol <jordi.pujol@aujac.org> 61 Catalan translation 62 * Eva Dachs <evadachs@terra.es> 63 Catalan translation 64 * Toni Perez <toni.perez@aujac.org> 65 Catalan translation 66 * Sergios Karalis <sergios_k@hotmail.com> 67 Greek translation 68 * Thomas J. Stensas aka ShadowMaster <shadowmaster@shadow-realm.org> 69 Ultimate 3.x support 70 71 Anope credits: 72 73 * Adam Kramer <ribosome@anope.org> 74 * Adam <adam@anope.org> 75 * Alvaro Toledo <atoledo@keldon.org> 76 * Amanda Folson <amanda@anope.org> 77 * Andrew Berquist <vash@anope.org> 78 * Björn Stiddien <keeper@anope.org> 79 * Charles Kingsley <chaz@anope.org> 80 * Chris Hogben <heinz@anope.org> 81 * Daniel Engel <dane@zero.org> 82 * David <dv@diboo.net> 83 * David Narayan <jester@phrixus.net> 84 * David Robson <rob@anope.org> 85 * Daniele Nicolucci <jollino@sogno.net> 86 * Florian Schulze <certus@anope.org> 87 * Gabriel Acevedo H. <drstein@anope.org> 88 * Jan Milants <viper@anope.org> 89 * Jens Voss <dukepyrolator@anope.org> 90 * JH <jh@irc-chat.net> 91 * Joris Vink <joris@anope.org> 92 * Lee Holmes <lethality@anope.org> 93 * Lucas Nussbaum <lucas@lucas-nussbaum.net> 94 * Mark Summers <mark@goopler.net> 95 * Matthew Beeching <jobe@mdbnet.co.uk> 96 * Naram Qashat <cyberbotx@anope.org> 97 * Phil Lavin <phil@anope.org> 98 * Pieter Bootsma <geniusdex@anope.org> 99 * Robin Burchell <w00t@inspircd.org> 100 * Sean Roe <therock247uk@anope.org> 101 * Sebastian V <hal9000@anope.org> 102 * Thomas Juberg Stensås <ShadowMaster@Shadow-Realm.org> 103 * Trystan .S Lee <trystan@nomadirc.net> 104 * openglx <openglx@brasnerd.com.br> 105 106 Anope Translations: 107 108 * Robby <robby@chatbelgie.be> (nl_NL) 109 * Kein <kein-of@yandex.ru> (ru_RU) 110 * Maik Funke <Han@mefalcon.org> (de_DE) 111 * Isaac Fontal <i_fontal@hotmail.com> (es_ES) 112 * Janos Kapitany <sarkanyka@cjbchat.hu> (hu_HU) 113 * Szymon S'wierkosz <szymek@adres.pl> (pl_PL) 114 * Christopher N. <saka@epiknet.org> (fr_FR) 115 * Yusuf Kurekci <ysfm.20@gmail.com> (tr_TR) 116 117 Anope Web panel: 118 119 * Denis M. (Phr33d0m) <god@politeia.in> 120 121 2) Presentation 122 123 Anope is a set of Services for IRC networks that allows users to manage 124 their nicks and channels in a secure and efficient way, and administrators 125 to manage their network with powerful tools. 126 127 Currently available services are: 128 129 * NickServ, a powerful nickname manager that users can use to protect 130 themselves against nick stealing. Each user has its own nickname 131 group, that allows the user to register as many nicks as needed 132 while still being able to take profit of his privileges and to 133 modify the nick configuration. NickServ also has an optional 134 password retrieval feature. 135 136 * ChanServ, a powerful channel manager that helps users to administer 137 their channels in a totally customizable way. ChanServ has an 138 internal list of privileged users and banned users that controls 139 accesses on a per-channel basis. It eliminates all takeover 140 problems, because of its powerful op/unban/invite and even mass 141 deop and mass kick functions. 142 143 * MemoServ, an helpful companion that allows sending short messages 144 to offline users, that they can then read when they come online 145 later. 146 147 * BotServ, an original service that allows users to get a permanent, 148 friendly bot on their channels in an easy way. Each bot can be 149 configured to monitor the channels against floods, repetitions, 150 caps writing, and swearing, and to take appropriate actions. It 151 also can handle user-friendly commands (like !op, !deop, !voice, 152 !devoice, !kick, and many others), say a short greet message when 153 an user joins a channel, and even "take over" ChanServ actions such 154 as auto-opping users, saying the entry notice, and so on. This 155 service can be disabled if you want to save some bandwidth. 156 157 * OperServ, the IRCops' and IRC admins' black box, that allows them 158 to manage the list of network bans (also known as AKILL (DALnet) or 159 GLINE (Undernet)), to configure messages displayed to users when 160 they log on, to set modes and to kick users from any channel, to 161 send notices quickly to the entire network, and much more! 162 163 * HostServ, a neat service that allows users to show custom vHosts 164 (virtual hosts) instead of their real IP address; this only works 165 on daemons supporting ip cloaking, such as UnrealIRCd. 166 167 Anope currently works with: 168 169 * Bahamut 1.4.27 or later (including 1.8) 170 * Charybdis 3.4 or later 171 * ircd-hybrid 8.2.23 or later 172 * InspIRCd 1.2 or later 173 * ngIRCd 19.2 or later 174 * Plexus 3 or later 175 * Ratbox 2.0.6 or later 176 * UnrealIRCd 3.2 or later 177 178 Anope could also work with some of the daemons derived by the ones listed 179 above, but there's no support for them if they work or don't work. 180 181 182 3) Installation 183 184 See the INSTALL file for instruction on installing Anope. 185 186 187 4) Command Line Options 188 189 Normally, Anope can be run simply by invoking the "services" executable. 190 Any of the following command-line options can be specified to change 191 the behavior of Anope: 192 193 --debug Enable debugging mode; more info sent to log (give 194 option more times for more info) 195 --readonly Enable read-only mode; no changes to databases 196 allowed 197 --nofork Do not fork after startup; log messages will be 198 written to terminal 199 --noexpire Expiration routines won't be run at all 200 --version Display the version of Anope 201 --nothird Do not load the non-core modules specified 202 --protocoldebug Debug each incoming message after protocol parsing 203 --support Used for support, same as --debug --nofork --nothird 204 205 Upon starting, Anope will parse its command-line parameters then 206 (assuming the --nofork option is not given) detach itself and run in the 207 background. If Anope encounters a problem reading the database files or 208 cannot connect to its uplink server, it will terminate immediately; 209 otherwise, it will run until the connection is terminated (or a QUIT, 210 SHUTDOWN, or RESTART command is sent; see OperServ's help). 211 212 In the case of an error, an appropriate error message will be written to 213 the log file. 214 215 If Anope is run with the "--readonly" command-line option, it can serve as 216 a "backup" to the full version of services. A "full" version of services 217 (run without --readonly) will automatically reintroduce its pseudo-clients 218 (NickServ, ChanServ, etc.), while a "backup" services will not, thus 219 allowing full services to be brought up at any time without disrupting 220 the network (and without having to take backup services down beforehand). 221 222 The "--debug" option is useful if you find or suspect a problem in Anope. 223 Giving it once on the command line will cause all traffic to and from 224 services as well as some other debugging information to be recorded in 225 the log file; if you send a bug report, PLEASE include an excerpt from 226 the log file WITH DEBUGGING ACTIVE; we cannot emphasize enough how 227 important this is to tracking down problems. (You can also enable 228 debugging while Services is running using OperServ's SET DEBUG command.) 229 If you repeat use --debug=<level>, the debugging level will be increased, 230 which provides more detailed information but may also slow Anope down 231 considerably and make the log file grow dramatically faster. In general, 232 a debug level of 1 is sufficient for the coding team to be able to trace 233 a problem, because all network traffic is included and we can usually 234 reproduce the problem. 235 236 5) Messages Translations 237 238 Please see LANGUAGE for this information 239 240 6) Contact 241 242 For announcements and discussions about Anope, please visit our 243 Portal and Forums at https://www.anope.org/ -- make sure you register 244 yourself to get full benefits. 245 246 If you read the documentation carefully, and didn't find the answer to 247 your question, feel free to post on the website forums or join our irc 248 channel (irc.anope.org #anope). Once you join our Support channel be as 249 precise as possible when asking a question, because we have no extraordinary 250 powers and can't guess things if they aren't provided. 251 252 The more precise you are the sooner you'll be likely to get an answer. 253 254 If you think you found a bug, add it to the bug tracking system 255 (https://bugs.anope.org/) and - again - be as precise as possible. Also say 256 whether the bug happens always or under what circumstances, and anything 257 that could be useful to track your bug down. If you wrote a patch, send 258 it over. :)