?;






Ver -

Help Menu: Section 2 - Installation

This is the BugLite help system, a detailed table of contents is available here...
The navigation bars at the top and bottom of each screen can also assist you. more...


logout back  main admin help


Table of Contents

Expanded Contents

Detailed Content List

Section-1

Introduction

Section-2

Installation

Section-3

Security

Section-4

Information & Reports

Section-5

Database Tools

Section-6

Site Tools

Revision History

2011 Versions

2010 Versions

Section - 2.1 Installation

 Section rev January 20, 2011

This is the installation instructions for BugLite version 2011.b and later.

STEP 1 - Load files to target directory

It is suggested that the first use of this program be off the document root directory in a sub directory called "BugLite". Once you confirm the program is running, it takes less than a minute to move it to some other directory.

The program (as it comes from me) is setup to run in http://localhost/buglite/. This is the development environment I use on my XP Win box. If you install to this sub-directory on your local computer, absolutely nothing would need to be changed in order for it to run :)

STEP 2 - Configure index.php

If you installing to a windows localhost machine in the http://localhost/buglite/ directory, you can skip this section.

Open "index.php" in a text editor and find the section of code similar to that shown below. It should be located around line number "50".

Modify the $_SESSION['BASEURL'] to point to the proper web address. If you placed the program in the suggested "BugLite" sub-directory, no further setup is required!

  
   #  +-----------------------------------------------------+
   #  |             INITIALIZE SESSION VARIABLES            |
   #  +-----------------------------------------------------+
                                                              
   #  url to program                                          
   #  example: 'http://www.example.com/buglite/';             
   #       or: 'http://localhost/buglite/';                   
      $_SESSION['BASEURL']    = 'http://localhost/buglite/';  
                                                              
   #  path to program from document root                      
   #  example: '/buglite/'                                    
      $program_dir = '/buglite/';                              
                                                              
   #  database name                                           
   #  example: 'bugs.sqlite3';                                
      $_SESSION['DBNAME']     = 'bugs.sqlite3';                
                                                              
   #  +-----------------------------------------------------+
   #  |          END OF USER CONFIGURABLE VARIABLES         |
   #  +-----------------------------------------------------+ 
      

STEP 3 - Database name

If you are going to use the default demo database, you can skip this section.

If you are using this program as it comes ready for install, a practice database is provided and will run automatically. If this is a re-installation and you have customized your database, then you need to copy your old database to the "Buglite" root directory and set the database name in index.php.

STEP 4 - File permissions

If you are installing to a windows machine, you can skip this section.

If you are using a Linux/Unix web server, make sure directory and file permissions are what they need to be. My web hosting provider messes with the file permissions during ftp uploads and I have to change them before Buglite will work!

Starting with Buglite ver 2011.b, a new utility is located in the Buglite root directory called
set-permissions.php. To use this utility, it must have it's permissions set to "644", then it can be run. It will recursively go through all Buglite files and directories and set them appropriately.

directory permissions = "755"
file permissions = "644"

STEP 5 - Run it!

Point your browser to the program sub directory...
 i.e. http://www.example.com/buglite/
 or   http://localhost/buglite/
You should get the login screen.

STEP 6 - Login

The pre-loaded DEMO DATABASE has two primary users. A "Guest" login is allowed so all you have to do is click on the login (leave the password blank). The guest user has all the normal access accept the admin menu.

To experiment with user privileges login with:
  user = guest   password = leave blank
   or
  user = admin   password = admin

STEP 7 - Preparing a live db

You really should play around with the demo db before using a working db - see the "hints" in the next section. However, when the time comes to use a working db, here is the setup procedure.

a)  Initialize a live db [admin]->[init default db]
b)  Disable unwanted categories, and create your own new choices
   of categories [admin]->[Category]
c)  The default db allows guest logins and auto registration, change
   these if you want something else [admin]->[site]
d)  Add any users, admins, or leads [admin]->[Users]
e)  The default new user privileges are set by user id=2. Change any
  default privilege settings in the user edit for id=2 [admin]->[Users]
f)  Change the admin password [admin]->[Users]

Section - 2.2 Hints

 Section rev January 20, 2011

To reset to demo database

a)  login as "admin"
b)  from main screen, select [admin]->[Init demo db]
c)  logout, then login again

Can't login

In all my development, I have never locked myself out. But if this were to happen, there is a simple way to get up and running again.

Each time you "init" the DEMO or LIVE database (or archive), a copy of the existing database and uploaded files are saved in a sub-directory under "archive" with a date-time stamp.

1)  Delete the dis-functional db in your program root directory.
2)  Copy one of the good archived database files to your program root directory.

Now you should be up and running again. It doesn't really matter what archived db you use, because all you are trying to accomplish is getting access back to the menu system where you can "init" another demo db.

Section - 2.3 When things go wrong

 Section rev January 20, 2011

The primary way to debug a new install is to get everything working with the DEMO DATABASE before attempting a LIVE database. The DEMO DATABASE has been extensively tested and used during the development process and therefor is a very stable platform.

Another good idea is to install the program in a sub-directory named "buglite" immediately after the html document root. No setup should be needed if this is done.

Finally, on UNIX systems, make sure the user, file and directory permission are set properly. The SQLite engine will not be able to open the database unless the "buglite" program root directory is writable.


← previous section table of contents next section →


logout back  main admin help