ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/ermyth/INSTALL
(Generate patch)

Comparing ermyth/INSTALL (file contents):
Revision 1.1 by pippijn, Thu Jul 19 08:24:46 2007 UTC vs.
Revision 1.5 by pippijn, Sat Sep 22 14:27:25 2007 UTC

1atheme-services -- a set of services for IRC networks 1Ermyth -- a set of services for IRC networks
2===================================================== 2=====================================================
3 3
4This program is free but copyrighted software; see the LICENSE file for 4Ermyth is free software: you can redistribute it and/or modify
5details. 5it under the terms of the GNU General Public License as published by
6the Free Software Foundation, either version 3 of the License, or
7(at your option) any later version.
6 8
7Information about Services may be found at http://www.atheme.net/. 9Information about Ermyth may be found at http://ermyth.xinutec.org/.
8 10
9TABLE OF CONTENTS 11TABLE 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
17You should also read the README and FAQ files. 19You should also read the README and FAQ files.
18 20
191. INSTALLATION 211. INSTALLATION
20--------------- 22---------------
21 23
22NOTE: if you are using a third party package of Services, most of this section 24NOTE: if you are using a third party package of Ermyth, most of this section
23will not apply. 25will not apply.
24 26
25IMPORTANT NOTE: it is not recommended to use and install services as root. 27IMPORTANT NOTE: it is not recommended to use and install services as root.
26Use an unprivileged user account. 28Use an unprivileged user account.
27 29
28Services should compile and run on most POSIX compliant systems. The list of 30Ermyth should compile and run on most POSIX compliant systems. The list of
29platforms that atheme-services has been tested on includes: 31platforms 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]
34 OpenBSD 3.[5,6,7,8] (i386, amd64, sparc) 36 OpenBSD 3.[5,6,7,8] (i386, amd64, sparc)
… …
42 MacOS 10.[3.5,4.1] (intel, powerpc) 44 MacOS 10.[3.5,4.1] (intel, powerpc)
43 45
44Other BSD-based systems will probably work. Other SysV-based systems *might* 46Other BSD-based systems will probably work. Other SysV-based systems *might*
45work provided they support BSD sockets and POSIX function calls. 47work provided they support BSD sockets and POSIX function calls.
46 48
47Services requires a runtime linker. Systems which do not have a runtime linker
48will not be able to run services. However, most systems include a runtime
49linker these days.
50
51IRCd's known to be supported by Services are listed in the example 49IRCd's known to be supported by Ermyth are listed in the example
52config (dist/example.conf). The recommended ones are charybdis, ratbox, 50config (dist/example.conf). The recommended ones are charybdis, ratbox,
53inspircd, asuka, beware ircd (bircd), nefarious and undernet-ircu 51inspircd, asuka, beware ircd (bircd), nefarious and undernet-ircu
54(undernet). 52(undernet).
55 53
56The easy way: run the "setup" script. This does it all for you: 54The easy way: run the "setup" script. This does it all for you:
… …
69The "configure" script will run several tests, write several files, and exit. 67The "configure" script will run several tests, write several files, and exit.
70Once this is done you will want to compile services. To do this, simply 68Once this is done you will want to compile services. To do this, simply
71type: 69type:
72 $ make 70 $ make
73 71
74Services will compile. To install, type: 72Ermyth will compile. To install, type:
75 $ make install 73 $ make install
76 74
77The newly-compiled binary and several supporting files will be copied to the 75The newly-compiled binary and several supporting files will be copied to the
78directory you specified in the "configure" script. 76directory you specified in the "configure" script.
79 77
80It is recommended to keep the source directory; you will need it to 78It is recommended to keep the source directory; you will need it to
81(re)compile modules later. 79(re)compile modules later.
82 80
83Next, you'll want to go to the directory you specified in "configure" and edit 81Next, you'll want to go to the directory you specified in "configure" and edit
84etc/atheme.conf. You'll need to change every setting or services will 82etc/ermyth.conf. You'll need to change every setting or services will
85not work. 83not work.
86 84
872. UPGRADING 852. UPGRADING
88------------ 86------------
89 87
… …
98to a new format. 96to a new format.
99 97
1003. SETTING UP IRCD 983. SETTING UP IRCD
101------------------ 99------------------
102 100
103Services acts as an IRC server with pseudo-clients on it. To link it to 101Ermyth acts as an IRC server with pseudo-clients on it. To link it to
104your network, you'll need to add some lines in your IRCd's 102your network, you'll need to add some lines in your IRCd's
105configuration. Services connects to your IRCd, not the other way around. 103configuration. Ermyth connects to your IRCd, not the other way around.
106 104
107It is suggested that you set up your IRCd (IRC operator access, etc) before 105It is suggested that you set up your IRCd (IRC operator access, etc) before
108trying to connect services. Many IRCds do not log much about server 106trying to connect services. Many IRCds do not log much about server
109connections, so it is best to connect as an IRC operator and watch the 107connections, so it is best to connect as an IRC operator and watch the
110server notices. 108server notices.
… …
129running services. 127running services.
130 128
1314. STARTING SERVICES 1294. STARTING SERVICES
132-------------------- 130--------------------
133 131
134Go into the directory where you installed atheme-services (by default, 132Go into the directory where you installed ermyth (by default,
135~/atheme/). Type ./bin/atheme-services to launch services. 133~/ermyth/). Type ./bin/ermyth to launch services.
136 134
137Services will report any errors and/or detach into the background. 135Ermyth will report any errors and/or detach into the background.
138 136
139If services doesn't link and/or terminates without warning check the log 137If services doesn't link and/or terminates without warning check the log
140file (var/atheme.log) to see what happened. If this tells you nothing try 138file (var/ermyth.log) to see what happened. If this tells you nothing try
141rerunning services via ./bin/atheme-services -dn for more verbose 139rerunning services via ./bin/ermyth -nd for more verbose
142information. 140information.
143 141
1445. SETTING UP A CRONTAB ENTRY 1425. SETTING UP A CRONTAB ENTRY
145----------------------------- 143-----------------------------
146 144
147A crontab entry will allow you to check periodically whether services is 145A crontab entry will allow you to check periodically whether services is
148still running, and restart it if not. You'll need to have atheme-services 146still running, and restart it if not. You'll need to have ermyth
149binaries and data installed in the same directory for this to work 147binaries and data installed in the same directory for this to work
150without modification. 148without modification.
151 149
152First rename the dist/atheme.chk script that is in Atheme path (by default, 150First rename the dist/ermyth.chk script that is in Ermyth path (by default,
153~/atheme/) and edit it. You'll need to modify the "cd" part of the file. 151~/ermyth/) and edit it. You'll need to modify the "cd" part of the file.
154Then ensure that the file is marked as executable by typing 152Then ensure that the file is marked as executable by typing
155"chmod +x atheme.chk" and try to launch the script to see if it works. 153"chmod +x ermyth.chk" and try to launch the script to see if it works.
156 154
157When this is done, you'll have to add the crontab entry. Type "crontab -e" 155When this is done, you'll have to add the crontab entry. Type "crontab -e"
158This will open the default text editor with the crontab file. Enter the 156This will open the default text editor with the crontab file. Enter the
159following (with correct path): 157following (with correct path):
160 158
161*/5 * * * * /home/nenolod/atheme/etc/atheme.chk >/dev/null 2>&1 159*/5 * * * * /home/yourname/ermyth/etc/ermyth.chk >/dev/null 2>&1
162 160
163The */5 at the beginning means "check every 5 minutes." You may replace 161The */5 at the beginning means "check every 5 minutes." You may replace
164the 5 with other another number if you want (but less than 60). Save and exit, 162the 5 with other another number if you want (but less than 60). Save and exit,
165and it's installed. 163and it's installed.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines