]> jfr.im git - irc/borknet/trunk.git/blob - INSTALL
git-svn-id: https://svn.code.sf.net/p/borknet-dev-com/code/borknet_services/trunk...
[irc/borknet/trunk.git] / INSTALL
1 Installation of the BorkNet Services
2 ####################################
3
4 Copyright (C) 2004 Ozafy - ozafy@borknet.org - http://www.borknet.org
5 ---------------------------------------------------------------------
6
7 Table Of Contents:
8 ------------------
9 1. Requirements
10 2. Preparations
11 2.1 MySQL
12 2.2 PHP
13 3. Configuration
14 4. Running
15 5. Closing stuff
16
17
18
19 1. Requirements
20 ===============
21
22 Make sure you have installed the JDK 1.6 or higher.
23 http://java.sun.com/javase/downloads/index.jsp
24 Make sure you have installed MySQL 5.0 or higher.
25 http://dev.mysql.com/downloads/
26 Make sure you have installed the Java MySQL connector 3.0.
27 (As of writing there are problems with higher versions)
28 http://dev.mysql.com/downloads/connector/j/3.0.html
29
30
31
32 2. Preparations
33 ===============
34
35 2.1 MySQL
36 =========
37 create the correct database/user and import the borknet.sql file.
38 after this, run the CreateAccount program, which will create the
39 Services Admin account.
40
41 2.2 PHP
42 =======
43 since N uses md5 hashes of passwords in it's db, it is not possible to
44 retrieve user passwords. Because of this, we have created a possibility to
45 reset user passwords. When a user issues the requestpassword command, a
46 mail gets sent to the e-mail belonging to that auth account. In this e-mail
47 is a link, which, when clicked, will reset the user's password.
48 for this to work, you'll need to put up the requestpassword.php and
49 /incs/bork_connect.php files on your networks site, and add your networks
50 main address to the config. The links will then look something like
51 http://www.yournet.org/requestpassword.php?user=Username&code=dVrt6g .
52
53
54
55 3. Configuration
56 ================
57
58 edit bot.conf.
59
60 edit /core/modules/botname/botname.conf for each of the modules.
61
62
63
64 4. Running
65 ==========
66
67 ./services
68 (To turn off debugging/logging remove the flag from the startupline)
69
70 Makes sure you obey the directory structure, that means the Start.class file
71 should be in a directory called borknet_services, with all other dirs below.
72
73
74
75 5. Closing stuff
76 ================
77
78 Thank you for downloading this release!
79 Please report all bugs to ozafy@borknet.org or irc.borknet.org/BorkNet
80 Also feel free to just drop by and comment on the bot :)