|
1 EnanoBot - the Enano CMS IRC bot |
|
2 Copyright (c) 2008 Dan Fuhry |
|
3 |
|
4 This program is free software; you can redistribute it and/or modify it |
|
5 under the terms of the GNU General Public License as published by the Free |
|
6 Software Foundation; either version 2 of the License, or (at your option) |
|
7 any later version. |
|
8 |
|
9 This program is distributed in the hope that it will be useful, but WITHOUT |
|
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
|
12 more details. |
|
13 |
|
14 You should have received a copy of the GNU General Public License along |
|
15 with this program; if not, write to the Free Software Foundation, Inc., 59 |
|
16 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
|
17 |
|
18 EnanoBot is a bot I wrote for the Enano CMS IRC channel in #enano on freenode. It's |
|
19 written in CLI PHP and you need to have shell access, a MySQL server, and a host |
|
20 with a very permissive TOU or a reliable home connection to run this bot. |
|
21 |
|
22 FEATURES |
|
23 -------------------- |
|
24 |
|
25 - Basic logging |
|
26 - Privileged users - automatically opped and can speak through the bot, among |
|
27 other things |
|
28 - Snippets - use for automated help |
|
29 - Web-based log viewer |
|
30 - Web-based snippet manager |
|
31 |
|
32 REQUIREMENTS |
|
33 -------------------- |
|
34 |
|
35 - MySQL server |
|
36 - SSH access |
|
37 - PHP on your shell server |
|
38 - Working Enano installation |
|
39 - The MySQL user Enano uses needs to have access to EnanoBot's database if it's |
|
40 not the same one that you're using for Enano |
|
41 |
|
42 NOTE ON ISP RESTRICTIONS |
|
43 -------------------- |
|
44 |
|
45 A lot of ISPs (webhosts) prohibit running IRC bots from your shell account. Check |
|
46 with their terms of use before you enable this thing. Because this project is under |
|
47 the GPL there is of course no warranty for it, and nobody from the Enano Project |
|
48 can be responsible for your use of this bot. So make sure it's OK before you try to |
|
49 run it. |
|
50 |
|
51 INSTALLING |
|
52 -------------------- |
|
53 |
|
54 Copy config-sample.php to config.php and edit it. Then put irclogs.php and |
|
55 snippets.php wherever your Enano installation is. You could probably modify snippets |
|
56 to not use Enano pretty easily but securing it would be your job. Edit both irclogs |
|
57 and snippets to set the EnanoBot root directory (where your config and enanobot.php |
|
58 are). DO NOT put enanobot.php and config.php in your document root - you WILL get |
|
59 hacked. |
|
60 |
|
61 To start it, run: |
|
62 |
|
63 $ php enanobot.php |
|
64 |
|
65 You may find it useful to make sure that it restarts if it dies. Once you've started |
|
66 the bot and confirmed that it works, do something like: (and this is really hackish) |
|
67 |
|
68 $ while true; do php enanobot.php; done & |
|
69 |
|
70 This all assumes that you're on a Unix-based server. Things will be different on |
|
71 Windows. |
|
72 |
|
73 AUTHOR |
|
74 -------------------- |
|
75 |
|
76 Dan Fuhry <dan@enanocms.org> |
|
77 |