1 | ermyth -- 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 doc/poddoc/gplicense.pod |
4 | Ermyth is free software: you can redistribute it and/or modify |
5 | for details. |
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. |
6 | |
8 | |
7 | Information about Services may be found at http://ermyth.schmorp.de/. |
9 | Information about Ermyth may be found at http://ermyth.xinutec.org/. |
8 | |
10 | |
9 | TABLE OF CONTENTS |
11 | TABLE OF CONTENTS |
10 | ----------------- |
12 | ----------------- |
11 | 1. Installation |
13 | 1. Installation |
12 | 2. Upgrading |
14 | 2. Upgrading |
13 | 3. Setting up IRCd |
15 | 3. Setting up IRCd |
14 | 4. Starting Services |
16 | 4. Starting Ermyth |
15 | 5. Setting up a crontab entry |
17 | 5. Setting up a crontab entry |
16 | |
18 | |
17 | You should also read the README and FAQ files. |
19 | You should also read the README and FAQ files. |
18 | |
20 | |
19 | 1. INSTALLATION |
21 | 1. INSTALLATION |
20 | --------------- |
22 | --------------- |
21 | |
23 | |
22 | NOTE: if you are using a third party package of Services, most of this section |
24 | NOTE: if you are using a third party package of Ermyth, most of this section |
23 | will not apply. |
25 | will not apply. |
24 | |
26 | |
25 | IMPORTANT NOTE: it is not recommended to use and install services as root. |
27 | IMPORTANT NOTE: it is not recommended to use and install services as root. |
26 | Use an unprivileged user account. |
28 | Use an unprivileged user account. |
27 | |
29 | |
28 | Services should compile and run on most POSIX compliant systems. The list of |
30 | Ermyth should compile and run on most POSIX compliant systems. The list of |
29 | platforms that ermyth has been tested on includes: |
31 | platforms that ermyth has been tested on includes: |
30 | FreeBSD 4.[8,9,10,11] |
32 | FreeBSD 4.[8,9,10,11] |
31 | FreeBSD 5.[0,1,2,3,4] |
33 | FreeBSD 5.[0,1,2,3,4] |
32 | FreeBSD 6.[0] |
34 | FreeBSD 6.[0] |
33 | FreeBSD 7.[0] |
35 | FreeBSD 7.[0] |
… | |
… | |
42 | MacOS 10.[3.5,4.1] (intel, powerpc) |
44 | MacOS 10.[3.5,4.1] (intel, powerpc) |
43 | |
45 | |
44 | Other BSD-based systems will probably work. Other SysV-based systems *might* |
46 | Other BSD-based systems will probably work. Other SysV-based systems *might* |
45 | work provided they support BSD sockets and POSIX function calls. |
47 | work provided they support BSD sockets and POSIX function calls. |
46 | |
48 | |
47 | Services requires a runtime linker. Systems which do not have a runtime linker |
|
|
48 | will not be able to run services. However, most systems include a runtime |
|
|
49 | linker these days. |
|
|
50 | |
|
|
51 | IRCd's known to be supported by Services are listed in the example |
49 | IRCd's known to be supported by Ermyth are listed in the example |
52 | config (dist/example.conf). The recommended ones are charybdis, ratbox, |
50 | config (dist/example.conf). The recommended ones are charybdis, ratbox, |
53 | inspircd, asuka, beware ircd (bircd), nefarious and undernet-ircu |
51 | inspircd, asuka, beware ircd (bircd), nefarious and undernet-ircu |
54 | (undernet). |
52 | (undernet). |
55 | |
53 | |
56 | The easy way: run the "setup" script. This does it all for you: |
54 | The easy way: run the "setup" script. This does it all for you: |
… | |
… | |
69 | The "configure" script will run several tests, write several files, and exit. |
67 | The "configure" script will run several tests, write several files, and exit. |
70 | Once this is done you will want to compile services. To do this, simply |
68 | Once this is done you will want to compile services. To do this, simply |
71 | type: |
69 | type: |
72 | $ make |
70 | $ make |
73 | |
71 | |
74 | Services will compile. To install, type: |
72 | Ermyth will compile. To install, type: |
75 | $ make install |
73 | $ make install |
76 | |
74 | |
77 | The newly-compiled binary and several supporting files will be copied to the |
75 | The newly-compiled binary and several supporting files will be copied to the |
78 | directory you specified in the "configure" script. |
76 | directory you specified in the "configure" script. |
79 | |
77 | |
… | |
… | |
98 | to a new format. |
96 | to a new format. |
99 | |
97 | |
100 | 3. SETTING UP IRCD |
98 | 3. SETTING UP IRCD |
101 | ------------------ |
99 | ------------------ |
102 | |
100 | |
103 | Services acts as an IRC server with pseudo-clients on it. To link it to |
101 | Ermyth acts as an IRC server with pseudo-clients on it. To link it to |
104 | your network, you'll need to add some lines in your IRCd's |
102 | your network, you'll need to add some lines in your IRCd's |
105 | configuration. Services connects to your IRCd, not the other way around. |
103 | configuration. Ermyth connects to your IRCd, not the other way around. |
106 | |
104 | |
107 | It is suggested that you set up your IRCd (IRC operator access, etc) before |
105 | It is suggested that you set up your IRCd (IRC operator access, etc) before |
108 | trying to connect services. Many IRCds do not log much about server |
106 | trying to connect services. Many IRCds do not log much about server |
109 | connections, so it is best to connect as an IRC operator and watch the |
107 | connections, so it is best to connect as an IRC operator and watch the |
110 | server notices. |
108 | server notices. |
… | |
… | |
132 | -------------------- |
130 | -------------------- |
133 | |
131 | |
134 | Go into the directory where you installed ermyth (by default, |
132 | Go into the directory where you installed ermyth (by default, |
135 | ~/ermyth/). Type ./bin/ermyth to launch services. |
133 | ~/ermyth/). Type ./bin/ermyth to launch services. |
136 | |
134 | |
137 | Services will report any errors and/or detach into the background. |
135 | Ermyth will report any errors and/or detach into the background. |
138 | |
136 | |
139 | If services doesn't link and/or terminates without warning check the log |
137 | If services doesn't link and/or terminates without warning check the log |
140 | file (var/ermyth.log) to see what happened. If this tells you nothing try |
138 | file (var/ermyth.log) to see what happened. If this tells you nothing try |
141 | rerunning services via ./bin/ermyth -nd for more verbose |
139 | rerunning services via ./bin/ermyth -nd for more verbose |
142 | information. |
140 | information. |