Main Menu

How To Install BugLite

This is the instllation instructions for BugLite version 1.0
This file was last updated by Jan W. Zumwalt - neatinfo.com (11/15/2010)

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

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 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.

STEP 4 - Run it!

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

STEP 5 - Login

The pre-loaded DEMO DATABASE has two primary users. "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 play with the administrator features login with:
  user = admin   password = admin

STEP 6 - Preparing a live db

You really should play around with teh 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]


To reset to demo database,

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

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 db, a copy of the existing database is saved in a sub-directory named "archive". The archived db is renamed with a date & time stamp prefix.

Delete the dis-functional db in your program root directory. Then copy one of these archived db's back to your program root directory and rename it to whatever your working db name is. (usually bugs.SQLite3)

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.

When things go wrong

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 SQLite3 engine will not be able to open the database unless the "buglite" program root directory is writable.