| 1 |
ermyth -- a set of services for IRC networks |
| 2 |
===================================================== |
| 3 |
|
| 4 |
Ermyth is free software: you can redistribute it and/or modify |
| 5 |
it under the terms of the GNU General Public License as published by |
| 6 |
the Free Software Foundation, either version 3 of the License, or |
| 7 |
(at your option) any later version. |
| 8 |
|
| 9 |
Information about ermyth may be found at http://ermyth.xinutec.org/. |
| 10 |
|
| 11 |
TABLE OF CONTENTS |
| 12 |
----------------- |
| 13 |
1. Credits |
| 14 |
2. Presentation, and what ermyth is not |
| 15 |
3. Installation |
| 16 |
4. Command line options |
| 17 |
5. Getting support |
| 18 |
6. Reporting bugs |
| 19 |
|
| 20 |
1. CREDITS |
| 21 |
---------- |
| 22 |
|
| 23 |
ermyth was originally based on Shrike, however, this has almost |
| 24 |
all been rewritten now. We have also borrowed some code from Sentinel |
| 25 |
and ircd-ratbox. |
| 26 |
|
| 27 |
Information about Shrike can be found at http://shrike.malkier.net/. |
| 28 |
Information about Sentinel can be found at http://ircd.botbay.net/sentinel/. |
| 29 |
Information about ircd-ratbox can be found at http://www.ircd-ratbox.org/. |
| 30 |
|
| 31 |
2. PRESENTATION AND WHAT ERMYTH IS NOT |
| 32 |
----------------------------------------------- |
| 33 |
|
| 34 |
ermyth is a set of Services for IRC networks that allows users to |
| 35 |
manage their channels in a secure and efficient way and allows operators to |
| 36 |
manage various things about their networks. Unlike it's predecessor, Shrike, |
| 37 |
services has a completely reworked form of channel management that feels |
| 38 |
somewhat like eggdrop and is somewhat more useful. |
| 39 |
|
| 40 |
Services currently works with many irc daemons. More details are |
| 41 |
available in the config file. |
| 42 |
|
| 43 |
Internally, ermyth shares more similarities with ircd than it |
| 44 |
does with IRCServices. Anope/Epona, Cygnus, OperStats, Hybserv, Theia, etc |
| 45 |
are all based on IRCServices and as such have very old legacy code that |
| 46 |
none of the authors, except Church truly understand. Ermyth was written |
| 47 |
completely from scratch with the more complex concepts taken from |
| 48 |
various modern ircd packages, including ircu, ircd-ratbox, hybrid and |
| 49 |
bahamut. |
| 50 |
|
| 51 |
ermyth is not a drop-in replacement for Anope or Andy Church's IRC |
| 52 |
Services. It is designed with an entirely different set of goals and as |
| 53 |
such should not be migrated to with the expectation that it will behave |
| 54 |
exactly like what was previously implemented. Ermyth is designed to act |
| 55 |
as a directory server, with alternative ways of getting to the data |
| 56 |
implemented as well as the IRC presence. |
| 57 |
|
| 58 |
3. INSTALLATION |
| 59 |
--------------- |
| 60 |
|
| 61 |
See the INSTALL file. |
| 62 |
|
| 63 |
4. COMMAND LINE OPTIONS |
| 64 |
----------------------- |
| 65 |
|
| 66 |
Normally, services can be run simply by invoking the "ermyth" |
| 67 |
executable. Services will then use the defaults specified in the |
| 68 |
configuraiton file and connect to the specified uplink server. |
| 69 |
Alternatively, any of the following command-line options can be |
| 70 |
specified to change the default behavior: |
| 71 |
|
| 72 |
-c </path/to/file> - specify the configuration file |
| 73 |
-d - start in debugging mode |
| 74 |
-h - print the help message and exit |
| 75 |
-n - do not fork into the background |
| 76 |
-v - print the version information and exit |
| 77 |
|
| 78 |
Services also handles the following signals: |
| 79 |
HUP - force a REHASH |
| 80 |
INT - force a RESTART |
| 81 |
TERM - force a SHUTDOWN |
| 82 |
|
| 83 |
Upon starting, ermyth will parse its command-line arguments, |
| 84 |
open its log file, parse its configuration file, load its database, |
| 85 |
connect to the uplink, and (assuming -n is not specified) detach into |
| 86 |
the background. If services encounters an error while parsing the |
| 87 |
configuration or database files it will terminate immediately. |
| 88 |
Otherwise, it will run until killed or otherwise stopped. |
| 89 |
|
| 90 |
5. GETTING SUPPORT |
| 91 |
------------------ |
| 92 |
|
| 93 |
If you are stuck, or services are doing something really weird, or you have |
| 94 |
some sort of brilliant idea, we have a channel on IRC! (Surprising, no?) |
| 95 |
To access this channel, connect to irc.atheme.org, and join #atheme. |
| 96 |
|
| 97 |
6. REPORTING BUGS |
| 98 |
----------------- |
| 99 |
|
| 100 |
If you find a bug in services, you must report it via the bugtracker; |
| 101 |
our developers have a tendency to forget things. Your bug is not |
| 102 |
actually a bug until it's reported. |
| 103 |
|
| 104 |
Report bugs at http://bugs-meta.atheme.org/. |
