← Back to branch summary

~budgester/irm/trunk

« back to all changes in this revision

Viewing changes to docs/INSTALL

  • Committer: budgester at budgester
  • Date: 2008-03-05 23:14:13 UTC
  • Revision ID: budgester@budgester.com-20080305231413-k5vqfuckfo09ju42
Initial import of IRM codebase

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/INSTALL
 
1
                          IRM INSTALL INSTRUCTIONS
 
2
                         --------------------------
 
3
 
 
4
If Things Go Wrong
 
5
------------------
 
6
 
 
7
Before we start, it is important that you know what to do if things go
 
8
wrong.  First, check the FAQ (in this directory), if that doesn't help,
 
9
e-mail irm-discuss@lists.sf.net, and we'll try to help you out.  Give as
 
10
much useful information as you can, such as your OS, PHP, and Webserver
 
11
details and versions, as well as which version of IRM you are running.
 
12
 
 
13
 
 
14
Requirements
 
15
------------
 
16
 
 
17
To install and run IRM, you will need the following:
 
18
 
 
19
* Webserver:  Apache is recomended, but others can work if you know how to
 
20
        configure them.  www.apache.org.
 
21
 
 
22
* PHP: You will need at least PHP 4.1.x, with the MySQL module enabled
 
23
        either as an extension or compiled into your PHP binary.
 
24
 
 
25
        If you want SNMP or LDAP support, you will need to have the relevant
 
26
        module enabled.
 
27
 
 
28
* Core PEAR: Preferably a fairly new version.  But PEAR doesn't really have
 
29
        released versions, so it's best just to upgrade to the latest
 
30
        version of PEAR (using "pear upgrade -o PEAR").
 
31
 
 
32
* The PEAR MDB package, version 1.3.0 or later (earlier versions are buggy). 
 
33
        Many pre-packaged PHP installations either do not come with MDB, or
 
34
        have older versions.  Please ensure that your MDB is up to date.
 
35
 
 
36
        You can either install MDB via the PEAR command
 
37
        (pear install -o mdb), or by downloading it manually from
 
38
        http://pear.php.net/package/MDB/download and placing it somewhere in
 
39
        your include_path.  Note, however, that a manual download will
 
40
        likely require several other packages to be manually installed
 
41
        properly.  If you have root access, somewhere like /usr/share/php is
 
42
        usually a good idea, otherwise you can place MDB.php and the MDB
 
43
        directory in the root of your IRM installation.
 
44
 
 
45
* If you want SNMP support, you will also need UCD SNMP installed.  See
 
46
        ucd-snmp.ucdavis.edu, or your distribution's package archive.
 
47
 
 
48
* If you want to use the new DHTML sidebar menu, you will need to install
 
49
        the PEAR TreeMenu package.  You can probably install it by running
 
50
        
 
51
                pear install -o html_treemenu
 
52
 
 
53
 
 
54
Installing
 
55
----------
 
56
 
 
57
By now you probably have already extracted IRM by gzip and tar.  If not, I'm
 
58
surprised you've managed to read these instructions so far...
 
59
 
 
60
Make sure that everything in this distribution tarball is placed in a
 
61
location that the webserver can access, either within the "document root" of
 
62
your installation, or else referenced by an Alias directive (or equivalent).
 
63
 
 
64
Next, setup the Database(s) that you want to use.  Typically, this will
 
65
involve the use of mysqladmin or similar to create the database, and a GRANT
 
66
command to give permissions to the database user.  For more information,
 
67
consult your MySQL manual.
 
68
 
 
69
Copy the file config/database.ini.dist to config/database.ini, and edit
 
70
config/database.ini to define the location, name, username, password, and
 
71
other information for your database.  The required format is documented in
 
72
database.ini.
 
73
 
 
74
If you want to get user information from LDAP, you should copy
 
75
config/ldap.ini.dist to config/ldap.ini and edit it to suit your needs. 
 
76
 
 
77
Point your web browser to admin.php within your IRM install.  For example,
 
78
if you installed IRM at http://www.schoenefeld.org/irm, point your web
 
79
browser to http://www.schoenefeld.org/irm/admin.php and follow the
 
80
instructions on the page.  After you complete this step, be sure to remove
 
81
the admin.php file for security reasons.
 
82
 
 
83
You are almost there!  Open your web browser to the irm directory, log in
 
84
with 'Admin' as the user and 'admin' as the password.  Next, click on the
 
85
"Setup" link at the top of the page, then click on "Configure IRM" in order
 
86
to configure IRM to suit your needs.
 
87
 
 
88
Finally, go through the list of pre-defined accounts and either remove the
 
89
ones you don't need, or set their passwords to strong values.  Please do not
 
90
leave the default accounts active with their default passwords.