| 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 Services may be found at http://www.atheme.net/. |
7 | Information about Services may be found at http://ermyth.schmorp.de/. |
| 8 | |
8 | |
| 9 | TABLE OF CONTENTS |
9 | TABLE OF CONTENTS |
| 10 | ----------------- |
10 | ----------------- |
| 11 | 1. Installation |
11 | 1. Installation |
| 12 | 2. Upgrading |
12 | 2. Upgrading |
| … | |
… | |
| 24 | |
24 | |
| 25 | IMPORTANT NOTE: it is not recommended to use and install services as root. |
25 | IMPORTANT NOTE: it is not recommended to use and install services as root. |
| 26 | Use an unprivileged user account. |
26 | Use an unprivileged user account. |
| 27 | |
27 | |
| 28 | Services should compile and run on most POSIX compliant systems. The list of |
28 | Services should compile and run on most POSIX compliant systems. The list of |
| 29 | platforms that atheme-services has been tested on includes: |
29 | platforms that ermyth has been tested on includes: |
| 30 | FreeBSD 4.[8,9,10,11] |
30 | FreeBSD 4.[8,9,10,11] |
| 31 | FreeBSD 5.[0,1,2,3,4] |
31 | FreeBSD 5.[0,1,2,3,4] |
| 32 | FreeBSD 6.[0] |
32 | FreeBSD 6.[0] |
| 33 | FreeBSD 7.[0] |
33 | FreeBSD 7.[0] |
| 34 | OpenBSD 3.[5,6,7,8] (i386, amd64, sparc) |
34 | OpenBSD 3.[5,6,7,8] (i386, amd64, sparc) |
| … | |
… | |
| 79 | |
79 | |
| 80 | It is recommended to keep the source directory; you will need it to |
80 | It is recommended to keep the source directory; you will need it to |
| 81 | (re)compile modules later. |
81 | (re)compile modules later. |
| 82 | |
82 | |
| 83 | Next, you'll want to go to the directory you specified in "configure" and edit |
83 | Next, you'll want to go to the directory you specified in "configure" and edit |
| 84 | etc/atheme.conf. You'll need to change every setting or services will |
84 | etc/ermyth.conf. You'll need to change every setting or services will |
| 85 | not work. |
85 | not work. |
| 86 | |
86 | |
| 87 | 2. UPGRADING |
87 | 2. UPGRADING |
| 88 | ------------ |
88 | ------------ |
| 89 | |
89 | |
| … | |
… | |
| 129 | running services. |
129 | running services. |
| 130 | |
130 | |
| 131 | 4. STARTING SERVICES |
131 | 4. STARTING SERVICES |
| 132 | -------------------- |
132 | -------------------- |
| 133 | |
133 | |
| 134 | Go into the directory where you installed atheme-services (by default, |
134 | Go into the directory where you installed ermyth (by default, |
| 135 | ~/atheme/). Type ./bin/atheme-services to launch services. |
135 | ~/ermyth/). Type ./bin/ermyth to launch services. |
| 136 | |
136 | |
| 137 | Services will report any errors and/or detach into the background. |
137 | Services will report any errors and/or detach into the background. |
| 138 | |
138 | |
| 139 | If services doesn't link and/or terminates without warning check the log |
139 | If services doesn't link and/or terminates without warning check the log |
| 140 | file (var/atheme.log) to see what happened. If this tells you nothing try |
140 | file (var/ermyth.log) to see what happened. If this tells you nothing try |
| 141 | rerunning services via ./bin/atheme-services -dn for more verbose |
141 | rerunning services via ./bin/ermyth -nd for more verbose |
| 142 | information. |
142 | information. |
| 143 | |
143 | |
| 144 | 5. SETTING UP A CRONTAB ENTRY |
144 | 5. SETTING UP A CRONTAB ENTRY |
| 145 | ----------------------------- |
145 | ----------------------------- |
| 146 | |
146 | |
| 147 | A crontab entry will allow you to check periodically whether services is |
147 | A crontab entry will allow you to check periodically whether services is |
| 148 | still running, and restart it if not. You'll need to have atheme-services |
148 | still running, and restart it if not. You'll need to have ermyth |
| 149 | binaries and data installed in the same directory for this to work |
149 | binaries and data installed in the same directory for this to work |
| 150 | without modification. |
150 | without modification. |
| 151 | |
151 | |
| 152 | First rename the dist/atheme.chk script that is in Atheme path (by default, |
152 | First 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. |
153 | ~/ermyth/) and edit it. You'll need to modify the "cd" part of the file. |
| 154 | Then ensure that the file is marked as executable by typing |
154 | Then 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. |
155 | "chmod +x ermyth.chk" and try to launch the script to see if it works. |
| 156 | |
156 | |
| 157 | When this is done, you'll have to add the crontab entry. Type "crontab -e" |
157 | When this is done, you'll have to add the crontab entry. Type "crontab -e" |
| 158 | This will open the default text editor with the crontab file. Enter the |
158 | This will open the default text editor with the crontab file. Enter the |
| 159 | following (with correct path): |
159 | following (with correct path): |
| 160 | |
160 | |
| 161 | */5 * * * * /home/nenolod/atheme/etc/atheme.chk >/dev/null 2>&1 |
161 | */5 * * * * /home/yourname/ermyth/etc/ermyth.chk >/dev/null 2>&1 |
| 162 | |
162 | |
| 163 | The */5 at the beginning means "check every 5 minutes." You may replace |
163 | The */5 at the beginning means "check every 5 minutes." You may replace |
| 164 | the 5 with other another number if you want (but less than 60). Save and exit, |
164 | the 5 with other another number if you want (but less than 60). Save and exit, |
| 165 | and it's installed. |
165 | and it's installed. |
