| 1 | atheme-services -- a set of services for IRC networks |
1 | ermyth -- a set of services for IRC networks |
| 2 | ===================================================== |
2 | ===================================================== |
| 3 | |
3 | |
| 4 | This program is free but copyrighted software; see the LICENSE file for |
4 | This program is free but copyrighted software; see the LICENSE file for |
| 5 | details. |
5 | details. |
| 6 | |
6 | |
| 7 | Information about atheme-services may be found at http://www.atheme.net/. |
7 | Information about ermyth may be found at http://ermyth.schmorp.de/. |
| 8 | |
8 | |
| 9 | TABLE OF CONTENTS |
9 | TABLE OF CONTENTS |
| 10 | ----------------- |
10 | ----------------- |
| 11 | 1. Credits |
11 | 1. Credits |
| 12 | 2. Presentation, and what atheme-services is not |
12 | 2. Presentation, and what ermyth is not |
| 13 | 3. Installation |
13 | 3. Installation |
| 14 | 4. Command line options |
14 | 4. Command line options |
| 15 | 5. Getting support |
15 | 5. Getting support |
| 16 | 6. Reporting bugs |
16 | 6. Reporting bugs |
| 17 | |
17 | |
| 18 | 1. CREDITS |
18 | 1. CREDITS |
| 19 | ---------- |
19 | ---------- |
| 20 | |
20 | |
| 21 | atheme-services was originally based on Shrike, however, this has almost |
21 | ermyth was originally based on Shrike, however, this has almost |
| 22 | all been rewritten now. We have also borrowed some code from Sentinel |
22 | all been rewritten now. We have also borrowed some code from Sentinel |
| 23 | and ircd-ratbox. |
23 | and ircd-ratbox. |
| 24 | |
24 | |
| 25 | Information about Shrike can be found at http://shrike.malkier.net/. |
25 | Information about Shrike can be found at http://shrike.malkier.net/. |
| 26 | Information about Sentinel can be found at http://ircd.botbay.net/sentinel/. |
26 | Information about Sentinel can be found at http://ircd.botbay.net/sentinel/. |
| 27 | Information about ircd-ratbox can be found at http://www.ircd-ratbox.org/. |
27 | Information about ircd-ratbox can be found at http://www.ircd-ratbox.org/. |
| 28 | |
28 | |
| 29 | 2. PRESENTATION AND WHAT ATHEME-SERVICES IS NOT |
29 | 2. PRESENTATION AND WHAT ERMYTH IS NOT |
| 30 | ----------------------------------------------- |
30 | ----------------------------------------------- |
| 31 | |
31 | |
| 32 | atheme-services is a set of Services for IRC networks that allows users to |
32 | ermyth is a set of Services for IRC networks that allows users to |
| 33 | manage their channels in a secure and efficient way and allows operators to |
33 | manage their channels in a secure and efficient way and allows operators to |
| 34 | manage various things about their networks. Unlike it's predecessor, Shrike, |
34 | manage various things about their networks. Unlike it's predecessor, Shrike, |
| 35 | services has a completely reworked form of channel management that feels |
35 | services has a completely reworked form of channel management that feels |
| 36 | somewhat like eggdrop and is somewhat more useful. |
36 | somewhat like eggdrop and is somewhat more useful. |
| 37 | |
37 | |
| 38 | Services currently works with many irc daemons. More details are |
38 | Services currently works with many irc daemons. More details are |
| 39 | available in the config file. |
39 | available in the config file. |
| 40 | |
40 | |
| 41 | Internally, atheme-services shares more similarities with ircd than it |
41 | Internally, ermyth shares more similarities with ircd than it |
| 42 | does with IRCServices. Anope/Epona, Cygnus, OperStats, Hybserv, Theia, etc |
42 | does with IRCServices. Anope/Epona, Cygnus, OperStats, Hybserv, Theia, etc |
| 43 | are all based on IRCServices and as such have very old legacy code that |
43 | are all based on IRCServices and as such have very old legacy code that |
| 44 | none of the authors, except Church truly understand. Atheme was written |
44 | none of the authors, except Church truly understand. Ermyth was written |
| 45 | completely from scratch with the more complex concepts taken from |
45 | completely from scratch with the more complex concepts taken from |
| 46 | various modern ircd packages, including ircu, ircd-ratbox, hybrid and |
46 | various modern ircd packages, including ircu, ircd-ratbox, hybrid and |
| 47 | bahamut. |
47 | bahamut. |
| 48 | |
48 | |
| 49 | atheme-services is not a drop-in replacement for Anope or Andy Church's IRC |
49 | ermyth is not a drop-in replacement for Anope or Andy Church's IRC |
| 50 | Services. It is designed with an entirely different set of goals and as |
50 | Services. It is designed with an entirely different set of goals and as |
| 51 | such should not be migrated to with the expectation that it will behave |
51 | such should not be migrated to with the expectation that it will behave |
| 52 | exactly like what was previously implemented. Atheme is designed to act |
52 | exactly like what was previously implemented. Ermyth is designed to act |
| 53 | as a directory server, with alternative ways of getting to the data |
53 | as a directory server, with alternative ways of getting to the data |
| 54 | implemented as well as the IRC presence. |
54 | implemented as well as the IRC presence. |
| 55 | |
55 | |
| 56 | 3. INSTALLATION |
56 | 3. INSTALLATION |
| 57 | --------------- |
57 | --------------- |
| … | |
… | |
| 59 | See the INSTALL file. |
59 | See the INSTALL file. |
| 60 | |
60 | |
| 61 | 4. COMMAND LINE OPTIONS |
61 | 4. COMMAND LINE OPTIONS |
| 62 | ----------------------- |
62 | ----------------------- |
| 63 | |
63 | |
| 64 | Normally, services can be run simply by invoking the "atheme-services" |
64 | Normally, services can be run simply by invoking the "ermyth" |
| 65 | executable. Services will then use the defaults specified in the |
65 | executable. Services will then use the defaults specified in the |
| 66 | configuraiton file and connect to the specified uplink server. |
66 | configuraiton file and connect to the specified uplink server. |
| 67 | Alternatively, any of the following command-line options can be |
67 | Alternatively, any of the following command-line options can be |
| 68 | specified to change the default behavior: |
68 | specified to change the default behavior: |
| 69 | |
69 | |
| … | |
… | |
| 76 | Services also handles the following signals: |
76 | Services also handles the following signals: |
| 77 | HUP - force a REHASH |
77 | HUP - force a REHASH |
| 78 | INT - force a RESTART |
78 | INT - force a RESTART |
| 79 | TERM - force a SHUTDOWN |
79 | TERM - force a SHUTDOWN |
| 80 | |
80 | |
| 81 | Upon starting, atheme-services will parse its command-line arguments, |
81 | Upon starting, ermyth will parse its command-line arguments, |
| 82 | open its log file, parse its configuration file, load its database, |
82 | open its log file, parse its configuration file, load its database, |
| 83 | connect to the uplink, and (assuming -n is not specified) detach into |
83 | connect to the uplink, and (assuming -n is not specified) detach into |
| 84 | the background. If services encounters an error while parsing the |
84 | the background. If services encounters an error while parsing the |
| 85 | configuration or database files it will terminate immediately. |
85 | configuration or database files it will terminate immediately. |
| 86 | Otherwise, it will run until killed or otherwise stopped. |
86 | Otherwise, it will run until killed or otherwise stopped. |
